General Guidelines when it comes to using comments
These sections are based on the book "Code Complete 2", Chapter 32, Self-Documenting code
Comment Arguments
Pro & Con
Types of Comments
trivial, explaination, marker, summary, intent, meta-comments
General Tips on Comments
Commenting Individual Lines
Commenting Paragraphs of Code
Commenting Data Declarations
Commenting Control Structures
Commenting Routines
Commenting Classes
Commenting Files
Commenting Programs
--
ShawnDB
- 16 Jun 2008
Revision: r1.1 - 16 Jun 2008 - 02:59 - Main.guest
TModeling
>
Software
>
CodeGuide
>
StyleGuide
>
Comments
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki?
Send feedback