You can even annotate sidenotes themselves with another sidenotes! Therefore, you can annotate any file format that allows comments inside it. The extension uses VSCode 'toggle comment' action to generate anchors, that allows it to be agnostic about language the document is written in. Supported extensions and languages Source document 'Content' side and 'source' document side are linked via the common unique id that is stored in anchor comment and is used to fetch associated content from content file. Sidenotes content are stored in separate files (' content files'), that are linked to the source document via the special comments in your code( anchor comments). The solution is to 'externalize' your notes, but keep them anchored to certain lines of your code, so that you can easily peek/edit them at any time. With usual comments there's no usual way to help it, if your code is commited under VCS other than delete them altogether. There may be notes that are private in nature and are not intended to be seen for other people, who might happen to read / edit your code. Unfortunately, VSCode has no way to hide/fold all comments. But delete them - and you may miss some important point later. Too many / too large comments clutter your code and make it hard to concentrate on the code itself. How should you manage this information?Ĭomments are usually the poor tool for this job. There also could be some ideas, detailed 'todos', issue analysis, conclusions, alternative code variants or something alike that you what to recall later when revising your code. A common case is describing why your wrote your code in such a way to remember later and don't make the same mistake twice. To a certain extent it's true, but sometimes you need to make some extended notes regarding to particular part of your code, that the code just can't say for itself. Many times we all heard a saying that good code documents itself.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |