Basic Program annotation knowledge

Basic Program annotation knowledge

Author: Chen yuefeng

From: http://blog.csdn.net/mailbomb

 

Program annotation is an important part of writing a standard program. The following are some notes:

L annotation: facilitates code reading and maintenance (modification ).

L annotations are ignored during code compilation and are not compiled into the final executable file. Therefore, Annotations do not increase the size of the executable file.

L annotations can be written anywhere in the code, but are generally written in the development or end position of the Code.

L when modifying the program code, you must modify the relevant comments at the same time to keep the code and comments synchronized.

L in actual code specifications, the proportion of comments to program code should be about 20%, that is, about 20 comments should be included in 100 lines of programs.