关于程序注释的基础知识[四]
来源:互联网 发布:分治法求众数算法 编辑:程序博客网 时间:2024/05/13 17:06
½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:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。
说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。
- 关于程序注释的基础知识[四]
- 关于程序注释的基础知识
- 关于程序注释的基础知识[一]
- 关于程序注释的基础知识[二]
- 关于程序注释的基础知识[三]
- 关于AD12的一些程序注释
- 关于ArrayList 的基础知识的小程序
- 过滤注释的程序
- Java程序的注释
- 关于powerpoint的注释
- 关于Struts的注释
- 关于myeclipse的注释
- Oracle基础知识(四) - 触发器的基础知识
- (四)NS3中示例:second.cc和third.cc程序的注释
- DSP基础知识 (一) 20111128 -实验程序注释版
- prototype.js1.5.0开发者手册 译文+添加注释(四)关于ajax类的
- 小程序的基础知识
- 关于启动的基础知识
- jsp使用flash例子
- 关于程序注释的基础知识[三]
- 《裂变——看得见的未来》(继《未来的冲击》和《数字化生存》后的又一经典)
- Spring Web 中模块化配置文件的加载
- PHP通过php-java-bridge 调用Java类中方法
- 关于程序注释的基础知识[四]
- Linux BlueZ 下 Inquiry的实现
- 跨浏览器通用XMLHttpRequest
- Spring获取Bean的几种方式
- Google工作原理
- 放假留校
- 判断浏览器脚本detect
- Bluetooth HCI Event的处理
- PHP调用java的class