程序注释应遵守的原则

 时间:2026-02-15 07:54:24

1、1.一般情况下,源程序中有效注释量必须在20%以上,且注释应该准确,易懂,防止注释二义性。

注释应当与其描述的代码相邻,可放在代码的上方或者右方,不可放在下方,且要将注释与其上方的代码用空行隔开。

程序注释应遵守的原则

2、2.变量注释应该放在变量定义之后,并说明变量的用途和取值约定。

文件的头部必须进行注释,包括.h文件、.c文件、.cpp文件等。注释要列出版权说明、文件名称、版本号、生成日期、作者、内容提要、功能以及与其他文件的关系、修改日志等。

程序注释应遵守的原则

3、3.在函数的头部注释要列出函数的名称、功能、输入\输出参数,返回值与修改信息等等。

在用{  }包含的代码块的结束处应该加以注释。特别是有多重嵌套的时候。

应在代码的功能、意图层次上进行注释,要提供有用的、额外的信息。

程序注释应遵守的原则

4、4.如果数据结构声明(包含数组、结构、类等)不能充分注释的,必须加以注释。对数据结构的注释应该放在其上方相邻的位置,对结构中每个域(成员)的注释应放在此域的右方。

全部变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等进行说明。

程序注释应遵守的原则

5、5.对于switch语句下的case语句,如果因为特殊情况需要处理完一个case语句后进入另一个case语句进行处理,则必须在该case语句处理完、进入下一个case语句前加上明确的注释。这样能有效防止遗漏break语句,也能使维护人员清晰的了解程序的流程。

程序注释应遵守的原则

  • AutoCAD-通过二维图形创建实体
  • cad里面如何把一条直线从某点切断?
  • CAD怎么约束制图
  • cad如何画剖面线
  • CAD的图案填充功能如何使用
  • 热门搜索
    啤酒加味精的作用是什么 一进门看见什么最好 什么牌子好 防风的功效与作用 什么是鸡尾酒 松鼠的尾巴有什么作用 运动裤下的秘密by迷羊 佛手花的功效与作用 制氧机什么牌子好 知识的重要性