C 编码规则

关于注释:

20个等号,用于一般的注释 
 
/* ====================
* 
* 
==================== */
74个等号,共80个字符,用于主要段的区分 
 
/* ========================================================================== */
40个星号,用于函数前的说明
 
/* ****************************************
* 函數名:    
* 功能:
*     
* 入口:
*
* 出口:    
* 備註:    
**************************************** */
//
 
用于行内注释。

几点注意:

边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。

尽量避免在注释中使用缩写,特别是不常用缩写。

注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。

当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License