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
  • ISO 31000 Risk Management

    The ISO 31000 Risk Management framework is an international standard that provides businesses with guidelines and principles for ...

  • pure risk

    Pure risk refers to risks that are beyond human control and result in a loss or no loss with no possibility of financial gain.

  • risk reporting

    Risk reporting is a method of identifying risks tied to or potentially impacting an organization's business processes.

SearchSecurity
  • What is cyber hygiene and why is it important?

    Cyber hygiene, or cybersecurity hygiene, is a set of practices individuals and organizations perform regularly to maintain the ...

  • Pretty Good Privacy (PGP)

    Pretty Good Privacy or PGP was a popular program used to encrypt and decrypt email over the internet, as well as authenticate ...

  • email security

    Email security is the process of ensuring the availability, integrity and authenticity of email communications by protecting ...

SearchHealthIT
SearchDisasterRecovery
  • What is risk mitigation?

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

  • fault-tolerant

    Fault-tolerant technology is a capability of a computer system, electronic system or network to deliver uninterrupted service, ...

  • synchronous replication

    Synchronous replication is the process of copying data over a storage area network, local area network or wide area network so ...

SearchStorage
  • information lifecycle management (ILM)

    Information lifecycle management (ILM) is a comprehensive approach to managing an organization's data and associated metadata, ...

  • WORM (write once, read many)

    In computer media, write once, read many, or WORM, is a data storage technology that allows data to be written to a storage ...

  • direct access

    In computer storage, direct access is the process of reading and writing data on a storage device by going directly to where the ...

Close