1.注释规范1・1・规则1・1・1・一般情况下，源程序有效注释量必须在30%以上。说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。1・1・2・包的注释：包的注释写入一名为package.html的HTML格式说明文件放入当前路径。说明：方便JavaDoc收集示例：com/qjkj/msg/relay/comm/package.html1・1・3・包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。格式：
一句话简述。
详细描述。
产品模块名称和版本
公司版权信息示例：
为Relay提供通信类，上层业务使用本包的通信类与SP进行通信。
详细描述。。。。。。。。1・1・4・类和接口的注释：该注释放在package关键字之后，class或者interface关键字之前。说明：方便JavaDoc收集。示例：packagecom.qjkj.msg.relay.comm;/***注释内容*/publicclassCommManager类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述。说明：可根据需要列出：版本号、生成日期、作者、内容、功能、与其它类的关系等。如果一个类存在Bug，请如实说明这些Bug。格式:/**〈一句话功能简述〉〈功能详细描述〉@author@version@see@since作者］版本号，YYYY-MM-DD］相关类/方法］［品/模块版本］*@deprecated*/说明：描述部分说明该类或者接口的功能、作用、使用方法和
注意事项
软件开发合同注意事项软件销售合同注意事项电梯维保合同注意事项软件销售合同注意事项员工离职注意事项
，每次修改后增加作者和更新版本号和日期，@since表示从那个版本开始就有这个类或者接口,@deprecated表示不建议使用该类或者接口。示例:/***LogManager类集中控制对日志读写的操作。*全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器,*读取或写入符合条件的日志纪录。@author@version@see@see@since张三，李四，王五1.2,2001-03-25LogIteraotorBasicLogCommonLogl.0*/1・1・6・类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。示例：/***注释内容*/privateStringlogType;/***注释内容*/publicvoidwrite()1.1.7.成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。1・1・8・公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。格式:/**〈一句话功能简述〉〈功能详细描述〉@param参数1］参数1说明］@param参数2］参数2说明］@return［返回类型说明］@exception/throws［违例类型］［违例说明］@see类、类#方法、类#成员］@deprecated*/说明：@since表示从那个版本开始就有这个方法；@exception或throws列出可能仍出的异常；@deprecated表示不建议使用该方法。示例:/***根据日志类型和时间读取日志。*分配对应日志类型的LogReader,指定类型、查询时间段、条件和反复器缓冲数,*读取日志记录。查询条件为null或0表示无限制，反复器缓冲数为0读不到日/志0查询时间为左包含原则，即［startTime,endTime）。@paramlogTypeName日志类型名（在配置文件中定义的）@paramstartTime查询日志的开始时间@paramendTime查询日志的结束时间@paramlogLevel查询日志的级别@paramuserName查询该用户的日志@parambufferNum日志反复器缓冲记录数@return结果集，日志反复器@sinceCommonLog1・0*/publicstaticLogIteratorread(StringlogType,DatestartTime,DateendTime,intlogLevel,StringuserName,intbufferNum)1.1.9.对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。对于非RuntimeException,即throws子句声明会抛出的异常，必须在方法的注释中标明。说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注Runtime异常，@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。1・1・10・*注释应与其描述的代码相近，对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。1・1・11・*注释与所描述内容进行同样的缩排。说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。publicvoidexample(){//注释CodeBlockOne/注释CodeBlockTwo}应改为如下布局。publicvoidexample(){//注释CodeBlockOne//注释CodeBlockTwo}1・1・12・*将注释与其上面的代码用空行隔开。示例：如下例子，显得代码过于紧凑。//注释programcodeone//注释programcodetwo应如下
书
关于书的成语关于读书的排比句社区图书漂流公约怎么写关于读书的小报汉书pdf
写：//注释programcodeone//注释programcodetwo1・1・13・*对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看
设计
领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计
文档。1・1・14・*对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。1・1・15・*边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。1・1・16・*注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。1・1・17・*避免在注释中使用缩写，特别是不常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。1・2・建议1・2・1・*避免在一行代码或表达式的中间插入注释。说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。*通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。*在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息,帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。//女口果receiveFlag为真if(receiveFlag)而如下的注释则给出了额外有用的信息。//如果从连结收到消息if(receiveFlag)*在程序块的结束行右方加注释标记，以表明某程序块的结束。说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。if(...){programcodelwhile(index
本文档为【注释规范】，请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑，
图片更改请在作品中右键图片并更换，文字修改请直接点击文字进行修改，也可以新增和删除文档中的内容。
该文档来自用户分享，如有侵权行为请发邮件ishare@vip.sina.com联系网站客服，我们会及时删除。
[版权声明] 本站所有资料为用户分享产生，若发现您的权利被侵害，请联系客服邮件isharekefu@iask.cn，我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权，请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传，仅限个人学习分享使用，禁止用于任何广告和商用目的。
浙公网安备 33021202002483