Java 注释规范简介
前言:
最近完成了大创的程序编写,想放到网上,但一堆代码想来质量高不了,但好歹希望别人能看懂,这里学习一下注释规范,回去整理代码
基本注释:
备注1:持久化对象或VO对象的getter、setter方法不需加注释。
备注2:复杂功能也应该写在相应部分写好注释
(a) 类(接口)的注释。是简单的功能介绍。
/**
* 类的描述
* @author Administrator
* @Time 2012-11-2014:49:01
*/
(b) 构造函数的注释
/**
* 构造方法 的描述
* @param name
* 按钮的上显示的文字
*/
(c) 方法的注释
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @param [参数1] [in或out] [参数1说明]
* @param [参数2] [in或out] [参数2说明]
* @return [返回类型说明]
* @exception/throws [违例类型] [违例说明]
*/
(d) 全局变量的注释
/** The value is used for characterstorage. */
private final char value[];
(e) 字段/属性的注释
private int count;//浴室人数