java代码注释规范

1 致谢

感谢shiyuezhong网友提供的资料

链接如下：http://blog.csdn.net/shiyuezhong/article/details/8205281

有可能写的不是最好的但是是比较清楚的

在此推荐一下

2 前言

注释是很重要的尤其是对于Java这种高级的面向对象的语言

我使用的编译环境是Eclipse 我觉得挺好用的

很简单

以下的例子都是Youki觉得有用的注释功能

javadoc很强大 楼主觉得没有必要每一样都细说

就拿我觉得用得上的写一下吧

3 基本的格式

<b>...</b> 表示粗体

<br> 单符号 表示换行

4 Youki觉得需要注释的对象

函数、类、成员变量

5 类的注释

/** 
 * 类的描述
 * @author Administrator
 * @version m.n
 */

举例说明：

5 函数的注释

/** 
 * 方法的说明第一行 
 * 方法的说明第二行 
 * @param a 参数b的说明
 * @param b 参数a的说明
 * @return 返回值的说明
 */

举例说明

6 成员变量的注释

/** 
 * 成员变量的描述
 */

举例说明：