comment

(redirected from commenting)
Also found in: Dictionary, Thesaurus, Legal, Idioms.

comment

[′käm‚ent]
(computer science)
An expression identifying or explaining one or more steps in a routine, which has no effect on execution of the routine.

comment

(programming)
(Or "remark") Explanatory text embedded in program source (or less often data) intended to help human readers understand it.

Code completely without comments is often hard to read, but code with too many comments is also bad, especially if the comments are not kept up-to-date with changes to the code. Too much commenting may mean that the code is over-complicated. A good rule is to comment everything that needs it but write code that doesn't need much of it. Comments that explain __why__ something is done and how the code relates to its environment are useful.

A particularly irksome form of over-commenting explains exactly what each statement does, even when it is obvious to any reasonably competant programmer, e.g.

/* Open the input file */ infd = open(input_file, O_RDONLY);
References in periodicals archive ?
This year's comment volume dwarfed that and our analysis highlights the relative ease with which online commenting systems allow groups and individuals to mount large-scale campaigns for public policies.
This move by Google should enable users to have a completely open commenting system, i.
COMMENTING CENTRAL Miller explains that the editors at Nature wondered whether this boom in openness might benefit peer review.