Java注释规范整理.pdf

在软件开发的过程中总是强调注释的规范，但是没有一个具体的标准进行说明，通常都是在代码编写规范中简单的描述几句，不能作为一个代码注释检查的标准和依据，做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》，内容来自网络、书籍和自己的实际积累。会增加可执行文件的大小四、JAVA注释技巧空行和空白字符也是一种特殊注释。利用缩进和空行,使代码与注释容易区别,并协调美观。2、当代码比较长,特别是有多重嵌套时,为了使层次清晰,应当在一些段落的结束处加注释(在闭合的右花括号后注释该闭合所对应的起点),注释不能写得很长,只要能表示是哪个控制语句控制范围的结束即可,这样便于阅读。3、将注释与注释分隔符用一个空格分开,在没有颜色提示的情况下査看注释时,这样做会使注释很明显且容易被找到。4、不允许给块注释的周围加上外框。这样看起来可能很漂亮,但是难于维护。5、每行注释(迕同代码)不要超过120个字(1024×768),最好不要超过80字(800×600)。6、Jawa编辑器(iDE)注釋快捷方式。Ctrl+′注释当前行,再按则取消注释。7、对于多行代码的注释,尽量不采用“//”,而采用多行注释这样虽然麻烦,但是在做屏蔽调试时不用查找配对的“/*8、注释作为代码切换开关,用于临时测试屏蔽某些代码例一:codesegementl改动第一行就成了code segement t l例二:第一段有效,第二段被注释codesegementlcodesegement 2只需删除第一行的/就可以变成:-第一段被注释,第二段有效codesegemen tl;codesegemen t2五、JAVA注释方法及格式、单行(sing!e-ine)-短注释://……单独行注释:在代码中单起一行注释,注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。注释格式:八注释内容兴行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。注释格式://注释内容行尾注释:尾端( trailing)-极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。注释格式:代码+8(至少4)个空格+//注释内容2、块(b1ock)-块注释:/*……*/注释若干行,通常用于提供文件、方法、数据结构等的意乂与用途的说明,或者算法的挡述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成兴注释内容3、文档注释:/**…*注释若干行,并写入 javadoc文档。每个文档注释都会被置于注释定界符/兴/之中,注释文档将川来生成HTMI格式的代码报告,所以注释文档必须书写在类、域、构造函数、方法,以及字段( fiel d)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下:x the doget me thod of the servletThis me thod is called when a form has its tag value me thodk equals to get@param requestthe request send by the client to the serverx @param responsethe response send by the server to the client* @throws Servletexceptionf an error occurred@throws IOExceptionx if an error occurredpublicvoiddofet(httpservletrequestrequestHttpservletreSponseresponsethrows Servletexception, IOException idopost(request, response前两行为描述,描述完毕后,由@符号起头为坎标记注释。更多有关文档注释和javadoc的详细资料,参见javadoc的主页http://java.suncom/javadoc/index.htm4、 javadoc注释标签语法@ au thor对类的说明标明开发该类模块的作者@ version对类的说明标明该类模块的版本@see对类、属性、方法的说明参考转向,也就是相关主题@parm对方法的说明对方法中某参数的说明@ return对方法的说明对方法返回值的说明exception对方法的说明对方法可能抛出的异常进行说明六、JAVA注释具体实现、源文件注释源文件注释采用*……*/,在每个源文件的头部要有必要的注释信息,包括:文件名;文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模版大☆为文件名CopyRight (c)2008-XXXX文件编号:创建人日期修改人期描述决版本号大2、类(模块)注释:类(模块)注释釆用*…*/,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的DK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模坎)历史修改记录等。英文注释模版:大CopyRight(c)2008-xx8:3展望软件 Forsoft实 Proiect<项目工程名>Module ld:<(模块)类编号,可以引用系统设计中的类编号>k Comments:<对此类的描述,可以引用系统设计中的描述dk version used:决 Name space命名空间>x Author<作者中文名或拼音缩写>k Create Date:<创建日期,格式:YYYM-DDx Modified by:<修改人中文名或拼音缩写>Modified date:<修改日期,格式:YYM-Dkwhy& What is modified<修改原因描述>x Version<版木号如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释://Rewriter// Rewrite date:<修改日期:格式YYY-M-D> star t1:原代码内容//Endl.将原代码内容注释掉,然后添加新代码使用以下注释//Added by// add date:<添加日期,格式:YYMM-> Start2//End2:如果模块输入输岀参数或功能结枃有较大修改,则每次修改必须添加以下注释/LogI:// Depiction:<对此修改的描述>/∥ Writer:修改者中文名// Rewrite date:<模块修改日期,格式:YY-JM-D>2、接口注释接凵注释釆用…*/,在满足类注释的基础之上,接凵注释应该包含描述接凵的目的、它应如何被使用以及如何不被使用,块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。3、构造函数注释构造函数注释釆用/*…*,描述部分注明构造函数的作用,不一定有块标记部分注释模版默认构造函数注释模版二/块兴*descript ion带参数构造函数,初始化模式名,名称和数据源类型h@ param schema:模式名@ param name:名称param type:数据源类型大4、函数注释函数注释釆用/…/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能拙述;输入、输岀及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)注释模版一/函数名功能描述输入参数:<按照参数定义顺序>param后面空格后跟着参数的变量名字(不是类型),空格后跟着对该参数的挡述。>头返回值:-类型<说明><返国为空(void)的构造函数或者函数,@ re turn可以省略;如果返回值就是输入参数,必须川与输入参数的@ para相同的描述信息;必要的时侯注明特殊条件写的返回值。>异常:<按照异常名字的字母顺序>创建人日期:决修改人日期注释模版二:大大x funNamegetFirstspellDescription获取汉字拼音首字母的字符串,被生成百家姓函数调用x @paramstr the string是包含汉字的字符串@ return String:汉字返回拼音首字母字符串;英文字母返回对应的大写字母;其他非简体汉字返回0′;次@ Authorx @Create Date: 2008-07-025、方法注释方法注释采用**……*/,对于设置(Set方法)与获取(Get方法)成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索。6、方法内部注释控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。7、仝局变量注释:要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。8、局部(中间)变量注释:主要变量必须有注释,无特别意义的情况下可以不加注释9、实参/参数注释参数含义、及其它任何约束或前提条件。10、字段/属性注释:字段描述,属性说明。11、常量:常量通常具有一定的实际意义,要定义柞应说明。