Code Commenting Conformity Overview
One of the most important task in writing applications is, undoubtedly,
code documenting through commenting. The benefits of this operation are huge: not only that
instantly clarifies the functionality of certain pieces of code, but at
the application level ensures code readability, simplifies the documentation
process, helps future deployment and many more. No matter if you write
simple functions or complex classes, using comments, as often as possible,
is a standardization task that every application must achieve.
The CodeSMART Code Commenting Conformity tool will help you obtain a global perspective of
your code commenting, by indicating the blocks of code which have no related comments.
This apparently simple analysis can indicate, for example, a critical
uncommented function. The lack of a minimal documentation can bring unnecessary
extra efforts whenever you make a general review or the simplest change of this function.
See Also
Back To Top
|