JAVA代码注释规范.docx

JAVA代码注释规范

第一篇：JAVA代码注释规范JAVA代码注释规范一、规范存在的意义1.好的注释规范可以让人一眼看明白这是干什么的，特别是对于我们这种行业；共同合作完成一个项目需要分工明确，所以也需要有明了的注释规范。2.正确的应用注释规范可以增加代码的可读性、理解性。3.好的代码规范可以提高团队的开发效率，从而节省时间。4.长期的坚持代码规范可以让程序员养成一个良好的习惯，甚至锻炼出思维。二、命名规范1.一般概念1)尽量使用完整的英文描述。2)采用相对好理解的术语。3)采用骆驼命名的规范使名字增加可读性。4)尽量少用缩写提高可读性。5)避免名字过长。6)避免使用类似的名字。7)避免使用特殊符号。2.主要的运用1)类（class）的命名2)接口(interface)的命名+方法(method)的命名3)参数(param)的命名三、注释规范1.一般概念1)注释应该增加代码的清晰度2)保持代码的整洁3)在写代码之前或同时注意写上注释4)注释出为什么做这件事，做这件事的结果2.注释那些部分1)java文件：版权信息、创建时间、创建人2)类：目的、所完成功能、版权信息、创建人3)方法：参数含义、返回值4)属性：字段描述5)接口：目的、创建人、版本号、创建时间四、代码格式规范1.单行注释://注释内容，一般与代码后空4-8格，注释必须对齐2.块状注释：/*注释内容*/，一般是注释从以/*开始，以*/结束中的所有内容。3.文档注释：/**......*/所以注释文档必须书写在类、域、构造函数、方法，以及字段(field)定义之前.注释文档由两部分组成——描述、块标记。4.javadoc注释标签@author对类的说明标明开发该类模块的作者@version对类的说明标明该类模块的版本@see对类、属性、方法的说明参考转向，也就是相关主题@param对方法的说明对方法中某参数的说明@return对方法的说明对方法返回值的说明@exception对方法的说明对方法可能抛出的异常进行说明五、java注释具体实现1.源文件注释/***文件名*创建人*创建时间*修改人*描述*版本号*/2.类注释/***对此类的描述信息*创建人*版本号*创建时间*/3.方法的注释/***方法的用处*该方法的参数列*该方法返回的值*/4.属性的注释/***字段的描述*/5.接口注释/***对此接口的描述*创建人*创建时间*版本号*/6.构造方法注释/***描述该构造方法的用处*该构造方法的参数列*参数的类型*/六、Jsp代码格式规范1.多行注释:,一般是注释从以结束中的所有内容。2.文本注释:,主要是对该页面的一些描述，目的、创建人、创建时间、版本号、文件名、备注、修改人等.例如:3.伪劣标签注释:例如：4.单行注释：//注释内容，一般与代码后空4-8格，注释必须对齐七、JS代码格式规范1.文本注释:/**注释内容**/，主要是对该页面的一些描述，目的、创建人、创建时间、版本号、文件名、备注、修改人等.也可以用于注释代码块。例如:/***创建人*创建时间*版本号*文件名*备注*修改人**/2.文本注释:/**内容*/,主要是对该页面的一些描述，目的、创建人、创建时间、版本号、文件名、备注、修改人等.也可以用于注释代码块。例如:/***创建人*创建时间*版本号*文件名*备注*修改人*/3.单行注释://注释内容，一般与代码后空4-8格，注释必须对齐4.多行注释:/*注释内容*/,一般是注释从以/*开始，以*/结束中的所有内容。八、JS注释具体实现1.文件注释/***对此文件的描述信息*创建人*版本号*创建时间*/2.方法的注释/***方法的用处*该方法的参数列*该方法返回的值*/3.模块的注释/***模块名称*模块的用处*/第二篇：java注释规范总结在软件开发的过程中总是强调注释的规范，但是没有一个具体的标准进行说明，通常都是在代码编写规范中简单的描述几句，不能作为一个代码注释检查的标准和依据，做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》，内容来自网络、书籍和自己的实际积累。JAVA注释规范版本/状态作者版本日期1.0ghc2008-07-02一、背景1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？2、怎么样避免我们的注释冗长而且凌乱不堪呢？3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？二、意义程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件，在其整个生命周