原创力文档- 1、原创力文档（book118）网站文档一经付费（服务费），不意味着购买了该文档的版权，仅供个人/单位学习、研究之用，不得用于商业用途，未经授权，严禁复制、发行、汇编、翻译或者网络传播等，侵权必究。。
- 2、本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考，付费前请自行鉴别。如您付费，意味着您自己接受本站规则且自行承担风险，本站不退款、不进行额外附加服务；查看《如何避免下载的几个坑》。如果您已付费下载过本站文档，您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等，请点击“版权申诉”（推荐），也可以打举报电话：400-050-0827(电话支持时间：9:00-18:30)。
- 4、该文档为VIP文档，如果想要下载，成为VIP会员后，下载免费。
- 5、成为VIP后，下载本文档将扣除1次下载权益。下载后，不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后，您将拥有八大权益，权益包括：VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传，每下载1次， 网站将根据用户上传文档的质量评分、类型等，对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
编码规范1.0――
编码规范1.0――RD2（注释篇）
- PAGE 1 –
注释
1：一般情况下，源程序有效注释量必须在20％以上。
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。根据我们目前的实际情况，我们的注释选用中文注释，除非能使用熟练英文进行注释并且不会产生二义性。
2：说明性文件（如头文件.h文件、.hic文件、.hec文件、.het文件等）头部应进行注释， 注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、 修改日志等，源文件的注释中还应有函数功能简要说明。
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上
述信息建议要包含在内。
/*******************************************************/
文件名 : master.def *
项目: ROAD RUNNER *
模块 : *
* 日期 : (US) 7/17/96 16:51:34
* 版本 : 1.0
**
描述
*（描述的内容） *
**
历史记录 *
**
日期 | 作者 | 描述 *
**
04/28/95 | J.Thomas | Creation
**
09/29/97 | S.Letellier |- Modify to plug RTKE in RR-1.8
**
********************************************************/
3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的 /
功能、主要函数及其功能、修改日志等。
示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*******************************************************/
文件名 : master.def *
项目: ROAD RUNNER *
模块 : *
* 日期 : (US) 7/17/96 16:51:34
* 版本 : 1.0
**
描述
*（描述的内容） *
**
函数描述
1 **
1*函数名称
功| 能描述
**
历史记录 *
**
日期 | 作者 | 描述 *
**
04/28/95 | J.Thomas | Creation
**
09/29/97 | S.Letellier |- Modify to plug RTKE in RR-1.8
**
********************************************************************/
4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*S(***************************************************************************
函数名 : wcr1_26SemCardTitleTimerMngt()
对 象 : The timer armed by WUI to manage the new WML card title expired
调 用 : WCTR_CARD_TITLE_TIME_OUT_IND
**
使用的变量 :
*
* 使用的宏 :
*
*使用的其他函数 :
*
* 输入参数：
*
*函数返回值
**
描述
- Verify the timer is expired indeed
- Inform WUI that the timer, it previously armed, has expired
- Keep the same Fsm state
Next state: SAME
***************************************************************************)S*/
5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
6：注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。
7：避免在注释中使用缩写，特别是非常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。
8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
示例：如下例子不符合规范。例
文档评论（0）