Comment (computing)
5880
166746282
2007-10-24T14:05:12Z
Flipjargendy
352389
the word "program" lead to a disambiguation page. You should use specific links when dealing with words such as this. A program could be a television program. For more info see [[disambiguation]]
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 [[computer_program|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 (computer programming)]]
*[[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:Комментарии (программирование)]]