java的注释规范_Java 注释规范

基本的要求：

1、注释形式统一

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。

2、注释内容准确简洁

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

3、基本注释(必须加)

(a) 类(接口)的注释

(b) 构造函数的注释

(d) 全局变量的注释

(e) 字段/属性的注

备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或

VO对象的getter、setter方法不需加注释。具体的注释格式请参考下面举例。

4、特殊必加注释(必须加)

(a) 典型算法必须有注释。

(b) 在代码不明晰处必须有注释。

(d) 在循环和逻辑分支组成的代码中加注释。

(e) 为他人提供的接口必须加详细注释。

备注：此类注释格式暂无举例。具体的注释格式自行定义，要求注释内容准确简洁。

5、注释格式：

1)、单行(single-line)注释：“//……”

2)、块(block)注释：“/*……*/”

3)、文档注释：“/**……*/”

4)、javadoc注释标签语法

@author 对类的说明标明开发该类模块的作者

@version 对类的说明标明该类模块的版本

@see 对类、属性、方法的说明参考转向，也就是相关主题

@param 对方法的说明对方法中某参数的说明

@return 对方法的说明对方法返回值的说明

@exception 对方法的说明对方法可能抛出的异常进行说明

1 /**

2 建立一个用于操作数组的工具类，其中包含这常见的对数组的操作的函数:最值。3 @author张三4 @versionv.5 */

6 public classArrayTool{7

8 /**

9 获取整形数组的最大值10 @paramarr 接收一个元素为int类型的数组11 @return该数组的最大的元素值12 */

13 public int getMax(intarr){14 int Max =;15 returnMax;16 }17 }

java的注释规范_Java 注释规范相关推荐

java的书写规范_java书写规范以及技巧
一. Java命名的一般性指导 1. 类名首字母应该大写.属性(成员变量).方法.对象变量以及所有标识符(如形式参数.实际参数.局部变量)的首字母应小写,其中包含的所有单词都应紧靠在一起,而且大写 ...
java 虚拟机规范_Java虚拟机规范----Java虚拟机结构
Java体系和一些基本概念 Java平台的结构图: JVM与JRE.JDK关系? JVM:Java Virtual Machine(Java虚拟机),负责执行符合规范的Class文件 JRE: Jav ...
java高级规范_Java高级规范之二
二十一.提交java代码前应该检查是否有没用的语句,如:System.out.println(); jsp页面上面是否有alert调试信息不规范示例:暂无规范实例:暂无解析:因为如果保留了有可能 ...
java的书写规范_JAVA书写规范
命名规范 1.一般概念 1.尽量使用完整的英文描述符 2.采用适用于相关领域的术语 3.采用大小写混合使名字可读 4.尽量少用缩写,但如果用了,必须符合整个工程中的统一定义 5.避免使用长的名字(小于 ...
java 方法命名规范_Java命名规范
一.命名规范 1. 项目名全部小写 2. 包名全部小写 3. 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写. 如:public class MyFirstClass{} 4. 变量 ...
java 异常规范_java 异常规范
异常规范异常介绍 Throwable 所有Exception和Error的父类. Error 致命错误. 项目自身存在问题, 诸如格式有问题, 编译版本不对, 堆栈溢出等, 项目在出现ERROR的情 ...
java注释模板_Java注释模板设置
Java注释模板设置 eclipse中设置Java注释模板 eclipse设置注释模板的入口: Window->Preference->Java->Code Style->Co ...
java标签组件命名_java编程规范之java命名规范
想要成为一个优秀的程序员,首先要培养良好的编程习惯,为了提高代码的可读性,必须有好的命名规范. 这篇文章是小编结合网上的很多资料整理出来的,若有不当或错误的地方,欢迎大家指正在文章开始前,为方便阅读 ...
java的命名规则_Java命名规范
命名规范本规范主要针对java开发制定的规范项目命名项目创建,名称所有字母均小写,组合方式为:com.leadal.$projectName.$component.$hiberarchy. $p ...

java的注释规范_Java 注释规范

java的注释规范_Java 注释规范相关推荐

最新文章

热门文章