![](https://img-blog.csdnimg.cn/20201014180756780.png?x-oss-process=image/resize,m_fixed,h_64,w_64)
其他技术文章收集
文章平均质量分 73
siriurs
这个作者很懒,什么都没留下…
展开
-
关于程序注释的基础知识[四]
½2-1:避免在一行代码或表达式的中间插入注释。说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。½2-2:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。½2-3:在代码的功能、意图层次上进行注释,提供有用、额外的信息。说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。示例:如下注释意义不大。/* if r原创 2010-07-06 16:26:00 · 550 阅读 · 0 评论 -
关于程序注释的基础知识[一]
程序注释是书写规范程序时很重要的一个内容,下面是关于注释的一些说明:注释的作用:方便代码的阅读和维护(修改)。注释在编译代码时会被忽略,不编译到最后的可执行文件中,所以注释不会增加可执行文件的大小。注释可以书写在代码中的任意位置,但是一般写在代码的开发或者结束位置。修改程序代码时,一定要同时修改相关的注释,保持代码和注释的同步。在实际的代码规范中,要求注释占程序代码的比例达到20%左右,即100行程序中包含20行左右的注释。2 注释¹2-1:一般情况下,源程序有效注释量必须在20%以上。说明:注释的原则是有原创 2010-07-06 15:42:00 · 995 阅读 · 0 评论 -
关于程序注释的基础知识[三]
¹2-12:注释与所描述内容进行同样的缩排。说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。void example_fun( void ){/* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two}应改为如下布局:void example_fun( void ){ /* code one comments */ CodeBlock原创 2010-07-06 16:23:00 · 574 阅读 · 0 评论 -
关于程序注释的基础知识[二]
¹2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/************************************************* Function: // 函数名称 Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单 Called By:原创 2010-07-06 16:18:00 · 401 阅读 · 0 评论