myeclipse生成Javadoc的方法及编码错误解决
生成Javadoc的方法很简单，在项目上菜单栏->file->export->java->javadoc即可
但是直接生成会出现GBK编码错误，解决方法在第三步VM option中添加参数设置编码
-encoding UTF-8 -charset UTF-8
文档默认生成位置为工作空间中项目的doc目录下，以HTML格式来呈现
注释格式详解
/**
* 简述：这是一个hello类.
* 这是一个纯粹hello测试类，用来测试Javadoc的
* @author shadow
* @version 1.0
*
*/
/** … */注释分为两个部分：
- 描述部分：描述部分用来书写该类的作用或者相关信息
- 块标记部分：块标记部分必须注明作者和版本等。
描述部分
描述部分又分为简述和详细注释
- 简述部分：写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后详细注释。
- 详细注释：详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。详细注释会和简述部分合并为类的说明。
类的简述部分和详细注释部分不会自动换行，想要换行需要手动添加换行标签
例如
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
*
块标记部分
| 标签 | 说明 | JDK 1.1 doclet | 标准doclet | 标签类型 |
|---|---|---|---|---|
| @author 作者 | 作者标识 | √ | √ | 包、 类、接口 |
| @version 版本号 | 版本号 | √ | √ | 包、 类、接口 |
| @param 参数名 描述 | 方法的入参名及描述信息，如入参有特别要求，可在此注释。 | √ | √ | 构造函数、 方法 |
| @return 描述 | 对函数返回值的注释 | √ | √ | 方法 |
| @deprecated 过期文本 | 标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
| @throws异常类名 | 构造函数或方法所会抛出的异常。 | √ | 构造函数、 方法 | |
| @exception 异常类名 | 同@throws。 | √ | √ | 构造函数、 方法 |
| @see 引用 | 查看相关内容，如类、方法、变量等。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
| @since 描述文本 | API在什么程序的什么版本后开发支持。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
| {@link包.类#成员 标签} | 链接到某个特定的成员对应的文档中。 | √ | 包、类、接口、值域、构造函数、 方法 | |
| {@value} | 当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。 | √(JDK1.4) | 静态值域 |
此 外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、 {@code} {@value arg}几个不常用的标签，由于不常使用，我们展开叙述，感兴趣的读者可以查看帮助文档。
变量的域注释
方法的域注释
生成的javadoc文档
给包添加注释
方法1：在该包下新建一个package.html,内容如下,注释写在p标签中，换行使用br标签
<body>
<p>这是包注释<br>
这是包注释2</p>
</body>
方法2：使用pacakge-info.java类，具体使用方法如下
http://blog.sina.com.cn/s/blog_6826efe50100v8u1.html