Chinaunix首页 | 论坛 | 博客
  • 博客访问: 528310
  • 博文数量: 108
  • 博客积分: 3242
  • 博客等级: 中校
  • 技术积分: 916
  • 用 户 组: 普通用户
  • 注册时间: 2010-09-07 11:46
文章分类
文章存档

2012年(13)

2010年(95)

分类:

2010-09-14 13:40:13

2-1:避免在一行代码或表达式的中间插入注释。

说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。


½2-2:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。

说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。


½2-3:在代码的功能、意图层次上进行注释,提供有用、额外的信息。

说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。


示例:如下注释意义不大。

/* if receive_flag is TRUE */

if (receive_flag)

 

而如下的注释则给出了额外有用的信息。

/* if mtp receive a message from links */

if (receive_flag)


½2-4:在程序块的结束行右方加注释标记,以表明某程序块的结束。

说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。


示例:参见如下例子。

if (...)

{

    // program code

 

    while (index < MAX_INDEX)

    {

        // program code

    } /* end of while (index < MAX_INDEX) */ // 指明该条while语句结束

} /* end of  if (...)*/ // 指明是哪条if语句结束

 

½2-5:注释格式尽量统一,建议使用“/* …… */”。

 

½2-6:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。

说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。

阅读(1102) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~