java注释及常用场景

java注释及常用场景

1. java注释
   1）、单行(single-line)注释：“//……”
   一次只能注释一行，一般是简单注释，用来简短描述某个变量或属性，程序块。

   2）、块(block)注释：“/……/”
   为了进行多行简单注释，一般不使用。

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

   文档注释标签语法

				@author 对类的说明 标明开发该类模块的作者
				@version 对类的说明 标明该类模块的版本
				@see 对类、属性、方法的说明 参考转向，也就是相关主题
				@param 对方法的说明 对方法中某参数的说明
				@return 对方法的说明 对方法返回值的说明

可以使用多行，一般用来对类、接口、成员方法、成员变量、静态字段、静态方法、常量进行说明。Javadoc可以用它来产生代码的文档。为了可读性，可以有缩进和格式控制。

场景案例

1.类的注释

package ch;
/**
 * 
 * @author ch
 * @version 1.0
 *
 */

2.方法注释

/**
		 * 
		 * @param username
		 * @param password
		 * 
		 * @see 用户名密码的构造函数  
		 */
		public review(String username, String password) {
			super();
			this.username = username;
			this.password = password;
		}

3.对自定义字段或特定含义字段进行注释

		private String username; //用户名
		private String password; //密码