注释规范

注释规范2 注释为什么要有注释企业级软件生命周期的80%用于维护，对代码的可读性和可维护性要求非常高，性能反而被放到其次；我们在编写程序的时候必须重视代码质量。软件开发是一种高级脑力劳动，精妙的算法之后往往伴随着难以理解的代码，对于不经常维护的代码，往往连开发者本人也忘记编写的初衷。 SScompany的软件开发基于螺旋式软件开发模型，我们的Test系统在开发过程中不断因为不同客户的不同需求而做出相应的调整，不同项目组间同一功能模块的代码差异较大，即使同一项目组在不同时间段的代码也有可能完全不同，因此在开发更改过程中...

2 注释为什么要有注释企业级软件生命周期的80%用于维护，对代码的可读性和可维护性要求非常高，性能反而被放到其次；我们在编写程序的时候必须重视代码质量。软件开发是一种高级脑力劳动，精妙的算法之后往往伴随着难以理解的代码，对于不经常维护的代码，往往连开发者本人也忘记编写的初衷。 SScompany的软件开发基于螺旋式软件开发模型，我们的Test系统在开发过程中不断因为不同客户的不同需求而做出相应的调整，不同项目组间同一功能模块的代码差异较大，即使同一项目组在不同时间段的代码也有可能完全不同，因此在开发更改过程中，需要编写注释来记录我们所做的每一件事情，以便以后的维护者可以更容易的了解代码编写的原因，过程。诗言志，代码看人。要知道一个程序员的职业素养不用看薪金、资历、职位，只要去看他的代码便可知道，优雅的代码风格背后是高超技巧与丰富阅历的结合。好的代码使人钦佩，坏的代码使人鄙视；好的代码使人仰慕，坏的代码使人厌恶。出于经验和阅历的欠缺，我们可能无法写出大师级的优雅代码，但我们可以像大师们一样对代码详细注释。注释概述对大道的追求是人类不灭的理想，任何理论最终都是在解释这样的问题：我是谁？我从哪里来？我要到哪里去？同样，编写注释的目的有三：描述程序的目的、解释程序的功能、提示程序的细节。描述程序目的的部分要做到“详”、“尽”即又多又全，因为代码阅读者大部分时间是用来理解这段程序是怎么来地，（然后再了解这段程序是怎么没地）。根本目的在于告诉阅读者为什么会有着段程序这部分注释通常放在文件开头。解释程序功能的部分要做到“精”、“准”即没有废话，一眼就能知道程序是做什么的，代码阅读者根据这些注释知道应该对程序作什么样的调整。这部分注释通常用来放在方法开头。提示程序细节的部分需要编写者随机应变灵活控制，根据程序细节的不同或多或少或细或粗。其最终目的是让阅读者知道为什么程序要写成这样，这部分注释可能出现在代码的任何位置。以下是一些通用注释规则: 1、除非必要，不允许修改任何描述性注释；除非确实对方法做出过修改，不允许修改任何解释性注释；根据实际修改情况修改提示性注释。 2、如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。 3、描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。 4、除HTML和不重要的Javascript外任何对文件（类）的注释必须加上SScompany版权所有标志，此举对我们Test系统的版权非常重要。 /** *Copyright(c)2007SScompany Co.Ltd. *Allrightreserved. */ 5、每行注释（连同代码）不要超过120个字(1024×768)，最好不要超过80字(800×600) 。 6、任何注释必须遵循中文语法(英文注释必须遵循英文语法)，不能有错别字，正确使用标点符号。 7、当一段代码被更改，相应的注释也应改被更改。文章出处：http://www.diybl.com/course/3_program/c++/cppjs/200869/123832.html 2 注释 ¹2-1：一般情况下，源程序有效注释量必须在20％以上。说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 ¹2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. File name: // 文件名 Author: Version: Date: // 作者、版本及完成日期 Description: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1. .... History: // 修改历史记录列表，每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. ... *************************************************/ ¹2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************ Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. FileName: test.cpp Author: Version : Date: Description: // 模块描述 Version: // 版本信息 Function List: // 主要函数及其功能 1. ------- History: // 历史修改记录 David 96/10/12 1.0 build this moudle ***********************************************************/ 说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。 ¹2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* Function: // 函数名称 Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单 Called By: // 调用本函数的函数清单 Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序） Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序） Input: // 输入参数说明，包括每个参数的作 // 用、取值说明及参数间关系。 Output: // 对输出参数的说明。 Return: // 函数返回值的说明 Others: // 其它说明 *************************************************/ ¹2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 ¹2-6：注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。规则2-7：避免在注释中使用缩写，特别是非常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。 ¹2-8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。示例：如下例子不符合规范。例1： /* get replicate sub system index and net indicator */ repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; 例2： repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; /* get replicate sub system index and net indicator */ 应如下书写 /* get replicate sub system index and net indicator */ repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; ¹2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例： /* active statistic task number */ #define MAX_ACT_TASK_NUMBER 1000 #define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */ ¹2-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。示例：可按如下形式说明枚举/数据/联合结构。 /* sccp interface with sccp user primitive message name */ enum SCCP_USER_PRIMITIVE { N_UNITDATA_IND, /* sccp notify sccp user unit data come */ N_NOTICE_IND, /* sccp notify user the No.7 network can not */ /* transmission this message */ N_UNITDATA_REQ, /* sccp user's unit data transmission request*/ }; ¹2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例： /* The ErrorCode when SCCP translate */ /* Global Title failure, as follows */ // 变量作用、含义 /* 0 － SUCCESS 1 － GT Table error */ /* 2 － GT error Others － no use */ // 变量取值范围 /* only function SCCPTranslate() in */ /* this modual can modify it, and other */ /* module can visit it through call */ /* the function GetGTTransErrorCode() */ // 使用方法 BYTE g_GTTranErrorCode; ¹2-12：注释与所描述内容进行同样的缩排。说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。 void example_fun( void ) { /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two } 应改为如下布局。 void example_fun( void ) { /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two } ¹2-13：将注释与其上面的代码用空行隔开。示例：如下例子，显得代码过于紧凑。 /* code one comments */ program code one /* code two comments */ program code two 应如下书写 /* code one comments */ program code one /* code two comments */ program code two ¹2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。 ¹2-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。示例（注意斜体加粗部分）： case CMD_UP: ProcessUp(); break; case CMD_DOWN: ProcessDown(); break; case CMD_FWD: ProcessFwd(); if (...) { ... break; } else { ProcessCFW_B(); // now jump into case CMD_A } case CMD_A: ProcessA(); break; case CMD_B: ProcessB(); break; case CMD_C: ProcessC(); break; case CMD_D: ProcessD(); break; ... ½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：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。

                    本文档为【注释规范】，请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑，
                    图片更改请在作品中右键图片并更换，文字修改请直接点击文字进行修改，也可以新增和删除文档中的内容。 
 该文档来自用户分享，如有侵权行为请发邮件ishare@vip.sina.com联系网站客服，我们会及时删除。

                    [版权声明] 本站所有资料为用户分享产生，若发现您的权利被侵害，请联系客服邮件isharekefu@iask.cn，我们尽快处理。

                    本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权，请谨慎使用。

                    网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传，仅限个人学习分享使用，禁止用于任何广告和商用目的。
                

下载需要：免费已有0 人下载

立即下载

注释规范

你可能还喜欢