ALERT

[FREE DEMO] Deploy Your Enterprise Cloud in Minutes

Comment

Definition - What does Comment mean?

A comment is a special construct in a programming language that allows the program developer to mention additional information associated with the program. The main reason for including comments in programming languages is to improve the portability and maintainability of a code.

Techopedia explains Comment

Often, software development teams work together on different software modules, which are inspected by testing engineers during the testing process. During the process of testing, the engineers have to be aware of the workings of a module. Hence, comments are included by the developer to explain the workings of a particular module by stating the valid types of inputs, the number of inputs, the algorithm used for processing in the internal module, the expected outputs and the error conditions that may be encountered during processing.

Comments also often provide information regarding the author of the content, the date and time it was developed and the date and time it was last modified. How much detail to include is a matter of subjectivity. Some developers are notorious for hating comments and view them as a waste of time. To others, comments are an absolute necessity. In theory, an organization should lay all its coding standards. Still, for whatever reason, anybody who has inherited code from a previous development team will tell you more times than not that the code does not have the commenting they would of liked to see.

Techopedia Deals

Connect with us

Techopedia on Linkedin
Techopedia on Linkedin
Tweat cdn.techopedia.com
"Techopedia" on Twitter


'@Techopedia'
Sign up for Techopedia's Free Newsletter!

Email Newsletter

Join thousands of others with our weekly newsletter

Resources
The 4th Era of IT Infrastructure: Superconverged Systems
The 4th Era of IT Infrastructure: Superconverged Systems:
Learn the benefits and limitations of the 3 generations of IT infrastructure – siloed, converged and hyperconverged – and discover how the 4th...
Approaches and Benefits of Network Virtualization
Approaches and Benefits of Network Virtualization:
Businesses today aspire to achieve a software-defined datacenter (SDDC) to enhance business agility and reduce operational complexity. However, the...
Free E-Book: Public Cloud Guide
Free E-Book: Public Cloud Guide:
This white paper is for leaders of Operations, Engineering, or Infrastructure teams who are creating or executing an IT roadmap.
Free Tool: Virtual Health Monitor
Free Tool: Virtual Health Monitor:
Virtual Health Monitor is a free virtualization monitoring and reporting tool for VMware, Hyper-V, RHEV, and XenServer environments.
Free 30 Day Trial – Turbonomic
Free 30 Day Trial – Turbonomic:
Turbonomic delivers an autonomic platform where virtual and cloud environments self-manage in real-time to assure application performance.