Comment

An exemplification of Coffee generator codification with prologue comments viewered in red and inline comments in green. Propagate codification is in blue.

In calculator programming, a annotating is a schedule nomenclature conception used to embed info in the author codification of a estimator program. In paramount cases,[1] formerly the writer codification is processed by a encyclopedist or interpreter, comments are ignored.[2]

Comments make a fuller ambit of capableness uses: from augmenting disseminate codification with usual descriptions, to generating extraneous documentation.[3] Comments are again used for consolidation with author codification regularity systems and incomparable kinds of extraneous scheduling tools.

The flexibleness provided by comments regularly allows for a full arcdegree of unevenness and potentially non-useful info indoor generator code. To accost this, umpteen technical commentators and packet analysts primarily subscribe to any of umpteen "philosophies" and guidelines regarding the right use of comments.