Browse Definitions :
Definition

comment

Often cited as one of the most useful and least used programming conventions, a comment is a text note added to source code to provide explanatory information, usually about the function of the code. Comments are usually helpful to someone maintaining or enhancing your code when you are no longer around to answer questions about it. Peer developers sometimes assess code for the completeness and readability of its comments.

To enable the programming language compiler to recognize comments and not confuse them with instruction s, a special character is used (such as "#," " /* ," " ' " and " // ") to signal the beginning or the end of a comment. The HTML comment start characters ( <!-- ") tell the browser not to display the text between them and the end characters (" --> "); the text within these comment framing characters is visible, however, to anyone reading the code. Reading this page in a Web browser, for example, you can select "View" and then "Source" to see the HTML code for the page, including the comments.

A program should include at least: a file comment block that describes the contents of the file, so that someone reading the file can understand it without having to read the code itself, and a function comment block that describes each functional unit of code. In addition, some coders provide a comment for each language statement.

This was last updated in August 2005

Continue Reading About comment

SearchCompliance

  • information governance

    Information governance is a holistic approach to managing corporate information by implementing processes, roles, controls and ...

  • enterprise document management (EDM)

    Enterprise document management (EDM) is a strategy for overseeing an organization's paper and electronic documents so they can be...

  • risk assessment

    Risk assessment is the identification of hazards that could negatively impact an organization's ability to conduct business.

SearchSecurity

  • cyber espionage

    Cyber espionage, also called cyber spying, is a form of cyber attack that is carried out against a competitive company or ...

  • virus (computer virus)

    A computer virus is malicious code that replicates by copying itself to another program, computer boot sector or document and ...

  • honeypot (computing)

    A honeypot is a network-attached system set up as a decoy to lure cyber attackers and detect, deflect and study hacking attempts ...

SearchHealthIT

SearchDisasterRecovery

  • risk mitigation

    Risk mitigation is a strategy to prepare for and lessen the effects of threats faced by a business.

  • call tree

    A call tree is a layered hierarchical communication model that is used to notify specific individuals of an event and coordinate ...

  • Disaster Recovery as a Service (DRaaS)

    Disaster recovery as a service (DRaaS) is the replication and hosting of physical or virtual servers by a third party to provide ...

SearchStorage

  • cloud storage

    Cloud storage is a service model in which data is transmitted and stored on remote storage systems, where it is maintained, ...

  • cloud testing

    Cloud testing is the process of using the cloud computing resources of a third-party service provider to test software ...

  • storage virtualization

    Storage virtualization is the pooling of physical storage from multiple storage devices into what appears to be a single storage ...

Close