Comment (computing)

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 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.

ee 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]


Wikimedia Foundation. 2010.

Look at other dictionaries:

  • Computing Machinery and Intelligence — Computing Machinery and Intelligence, written by Alan Turing and published in 1950 in Mind, is a seminal paper on the topic of artificial intelligence in which the concept of what is now known as the Turing test was introduced to a wide audience …   Wikipedia

  • Comment — For comments in Wikipedia markup, see Help:Wiki markup#Invisible text (comments) and WP:COMMENT. A comment is generally a verbal or written remark often related to an added piece of information, or an observation or statement. These are usually… …   Wikipedia

  • Wikipedia:Reference desk/Computing — The Wikipedia Reference Desk covering the topic of computing. Computing #eee #f5f5f5 #eee #aaa #aaa #aaa #00f #36b #000 #00f computing Wikipedia:Reference de …   Wikipedia

  • Cloud Computing Manifesto — The Cloud Computing Manifesto is a manifesto containing a public declaration of principles and intentions for cloud computing providers and vendors[1], annotated as a call to action for the worldwide cloud community and dedicated belief that the… …   Wikipedia

  • Cloud computing — Les principaux acteurs du cloud computing Le cloud computing[1], informatique en nuage ou infonuagique est un concept qui consiste à déporter sur des serveurs distants des traitements informatiques traditionnellement localisés sur des serveurs lo …   Wikipédia en Français

  • Timeline of computing 1950–1979 — History of computing Hardware before 1960 Hardware 1960s to present Hardware in Soviet Bloc countries Artificial intelligence Computer science Operating systems Programming languages …   Wikipedia

  • Persuasive Computing — Der Begriff Persuasive Computing bzw. Rechnerüberzeugung bezeichnet ein Paradigma, bei dem Computertechnologien die Rolle eingeräumt wird, das Beurteilungs und Entscheidungsverhalten von Menschen bestimmend zu beeinflussen. Einerseits tritt… …   Deutsch Wikipedia

  • Persuasive computing — Der Begriff Persuasive Computing bzw. Rechnerüberzeugung bezeichnet ein Paradigma, bei dem Computertechnologien die Rolle eingeräumt wird, das Beurteilungs und Entscheidungsverhalten von Menschen bestimmend zu beeinflussen. Einerseits tritt… …   Deutsch Wikipedia

  • Assertion (computing) — In computer programming, an assertion is a predicate (i.e., a true–false statement) placed in a program to indicate that the developer thinks that the predicate is always true at that place. For example, the following code contains two assertions …   Wikipedia

  • Avatar (computing) — In computing, an avatar is the graphical representation of the user or the user s alter ego or character. It may take either a three dimensional form[1], as in games or virtual worlds, or a two dimensional form as an icon in Internet forums and… …   Wikipedia

Share the article and excerpts

Direct link
Do a right-click on the link above
and select “Copy Link”