javadoc

方法有三：

1.选择工程，在菜单Project->Genarate Javadoc

2.选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点”next” 按钮

3.选择工程，在菜单File->Export ，选择Java 下面的Javadoc ，点”next” 按钮

javadoc乱码解决

这里面有两个指定编码问题的参数

1) -encoding charsetName

2) -charset charsetName

第一个参数表示javadoc 程序读取java源文件时候应该采用什么编码

第二个参数表示javadoc 程序写html文件时采用的编码形式,并会在HTML中加入如下标签

<META http-equiv="Content-Type" content="text/html; charset=utf-8">

在第三个对话框的"Extra Javadoc options" 文本框里面加上：                 

-encoding UTF-8 -charset UTF-8

Java中有三种注释方法：

1. //被注释语句 

2. /*被注释语句*/

3. /**被注释语句*/

其中第三种专为JavaDoc设计，可以被JDK内置的JavaDoc工具支持和处理。

javadoc 标记有如下一些：
Tag           Introduced in JDK/SDK
@author              1.0
{@code}              1.5
{@docRoot}              1.3
@deprecated              1.0
@exception              1.0
{@inheritDoc}              1.4
{@link}              1.2
{@linkplain}              1.4
{@literal}              1.5
@param              1.0
@return              1.0
@see 1.0
@serial              1.2
@serialData              1.2
@serialField              1.2
@since              1.1
@throws              1.2
{@value}              1.4
@version              1.0

Overview Tags  @see @since  @author @version {@link}  {@linkplain}  {@docRoot}

Package Tags  @see @since  @serial @author @version {@link}  {@linkplain}  {@docRoot} 

Class/Interface Tags  @see @since  @deprecated @serial @author @version {@link}  {@linkplain}  {@docRoot}   

Field Tags  @see @since  @deprecated @serial @serialField {@link}  {@linkplain}  {@docRoot}  {@value}   

Method/Constructor Tags  @see @since  @deprecated @param @return @throws and @exception @serialData {@link}  {@linkplain}  {@inheritDoc}  {@docRoot}    

 

Order of Tags Include tags in the following order:

•@author (classes and interfaces only, required)

•@version (classes and interfaces only, required. See footnote 1)

•@param (methods and constructors only)

•@return (methods only)

•@exception (@throws is a synonym added in Javadoc 1.2)

•@see •

@since

•@serial (or @serialField or @serialData)

•@deprecated (see How and When To Deprecate APIs)

Multiple @author tags should be listed in chronological order, with the creator of the class listed at the top.

Multiple @param tags should be listed in argument-declaration order. This makes it easier to visually match the list to the declaration.

Multiple @throws tags (also known as @exception) should be listed alphabetically by the exception names.  

Multiple @see tags should be ordered as follows, which is roughly the same order as theirarguments are searched for by javadoc, basically from nearest to farthest access, from least-qualified to fully-qualified, The following list shows this progression. Notice the methods and constructors are in "telescoping" order, which means the "no arg" form first, then the "1 arg" form, then the "2 arg" form, and so forth. Where a second sorting key is needed, they could be listed either alphabetically or grouped logically.

http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html#javadocdocuments

http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#javadoctags