Comment (computing): Difference between revisions
Content deleted Content added
m moved MediaWiki talk:Comments to Comment (computing) over redirect: revert |
|||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| ⚫ | |||
In [[computing]], a '''comment''' is [[information]] in a [[file]] that is primarily intended as an [[annotation]]. The structure, scope and processing applied to this information depends on the [[syntax]] and conventions used to describe the information contained in the file. |
|||
A common occurrence are the comments that appear in the [[source code]] of a [[program]]. In this case the [[syntax]] of the [[programming language]] specifies the form that comments can take. Such comments could be said to be [[comment (computer programming)|computer programming comments]]. |
|||
Another common usage are the comments that appear in an initialization or configuration file. |
|||
[[Word processors]] often support an option that enables writers of documents to effectively write ''notes'' to themselves about the material they are writing. These ''notes'' are not visible to a reader of the document unless explicitly asked for. |
|||
==See also== |
|||
| ⚫ | |||
*[[Comment out]] |
|||
*[[Docstring]], a specific type of comment that is parsed and retained throughout the runtime of the program |
|||
*[[HTML comment tag]] |
|||
==External links== |
|||
* [http://dkrukovsky.blogspot.com/2005/07/how-to-write-comments.html How to Write Comments] by Denis Krukovsky |
|||
* [http://java.sun.com/j2se/javadoc/writingdoccomments/ How to Write Comments for the Javadoc Tool] |
|||
* [http://www.stack.nl/~dimitri/doxygen/index.html Doxygen, a documentation system for C, C++, Java, Objective-C, Python, IDL and to some extent PHP, C#, and D] |
|||
[[Category:Source code]] |
|||
[[Category:Reference]] |
|||
[[Category:Metadata]] |
|||
[[fr:Commentaire (informatique)]] |
|||
[[ja:コメント (コンピュータ)]] |
|||
[[pl:Komentarz (informatyka)]] |
|||
[[ru:Комментарии (программирование)]] |
|||
Latest revision as of 08:04, 24 January 2011
Redirect to: