程序注释应遵守的原则

2025-05-13 22:55:39

1、1.一般情况下,源程序中有效注释量必须在20%以上,且注释应该准确,易懂,防止注释二义性。注释应当与其描述的代码相邻,可放在代码的上方或者右方,不可放在下方,且要将注释与其上方的代码用空行隔开。

程序注释应遵守的原则

3、3.在函数的头部注释要列出函数的名称、功能、输入\输出参数,返回值与修改信息等等。在用{ }包含的代码块的结束处应该加以注释。特别是有多重嵌套的时候。应在代码的功能、意图层次上进行注释,要提供有用的、额外的信息。

程序注释应遵守的原则

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

程序注释应遵守的原则
声明:本网站引用、摘录或转载内容仅供网站访问者交流或参考,不代表本站立场,如存在版权或非法内容,请联系站长删除,联系邮箱:site.kefu@qq.com。
猜你喜欢