JasonShieh
- 浏览: 528505 次
- 性别:
- 来自: 上海
-
文章分类
最新评论
-
c7887qin：
貌似还要使用相同的证书进行签名。。。
Android - 如何将两个/多个应用放到一个进程中去？ -
北极光之吻：
天天向上1989 写道不是有OnDoubleTapListen ...
android实现双击事件监听 -
nielong123：
nielong123 写道onCheckedChanged(M ...
Android RadioGroup 换行, 支持多行多列 -
nielong123：
onCheckedChanged(MultiRadioGrou ...
Android RadioGroup 换行, 支持多行多列 -
zk_Ming：
zk_Ming 写道我用了你的，但是radiogroup 点击 ...
Android RadioGroup 换行, 支持多行多列
方法1：在eclipse中生成
在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。
在Javadoc Generation对话框中有两个地方要注意的：
javadoc command:应该选择jdk的bin/javadoc.exe
destination:为生成文档的保存路径，可自由选择。
按finish(完成)提交即可开始生成文档。
方法2：命令行方式生成
javadoc的命令行语法如下：
javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]
参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明：
• Packagenames 包列表。这个选项可以是一系列的包名（用空格隔开），例如java.lang java.lang.reflect java.awt。不过，因为javadoc不递归作用于子包，不允许对包名使用通配符；所以你必须显示地列出希望建立文档的每一个包。
• Sourcefiles 源文件列表。这个选项可以是一系列的源文件名（用空格隔开），可以使用通配符。javadoc允许四种源文件：类源代码文件、包描述文件、总体概述文件、其他杂文件。
◇ 类源代码文件：类或者接口的源代码文件。
◇ 包描述文件：每一个包都可以有自己的包描述文件。包描述文件的名称必须是"package.html"，与包的.java文件放置在一起。包描述文件的内 容通常是使用HTML标记写的文档。javadoc执行时将自动寻找包描述文件。如果找到，javadoc将首先对描述文件中<body> </body>之间的内容进行处理，然后把处理结果放到该包的Package Summary页面中，最后把包描述文件的第一句（紧靠<body>）放到输出的Overview summary页面中，并在语句前面加上该包的包名。
◇ 总体概述文件：javadoc可以创建一个总体概述文件描述整个应用或者所有包。总体概述文件可以被任意命名，也可以放置到任意位置。-overview 选项可以指示总体概述文件的路径和名称。总体概述文件的内容是使用HTML标记写的文档。javadoc在执行的时候，如果发现-overview选项， 那么它将首先对文件中<body></body>之间的内容进行处理；然后把处理后的结果放到输出的Overview summary 页面的底部；最后把总体概述文件中的第一句放到输出的Overview summary页面的顶部。
◇ 其他杂文件：这些文件通常是指与javadoc输出的HTML文件相关的一些图片文件、Java源代码文件（.java）、Java程序 （.class）、Java小程序（Applets）、HTML文件。这些文件必须放在doc-files目录中。每一个包都可以有自己的doc- files目录。举个例子，你希望在java.awt.Button的HTML文档中使用一幅按钮的图片（Button.gif）。首先，你必须把图片文 件放到C:usersrcjavaawtdoc-files中；然后在Button.java文件中加入下面注释
/**
* This button looks like this:
* <img src="doc-files/Button.gif">
*/
• @files 包含文件。为了简化javadoc命令，你可以把需要建立文档的文件名和包名放在一个或多个文本文件中。例如，为了简化下面命令：
javadoc -d apidoc com.mypackage1 com.mypackage2 com.mypackage3
你可以建立一个名称为mypackage.txt的文件，其内容如下：
com.mypackage1
com.mypackage2
com.mypackage3
然后执行下面命令即可：
javadoc -d apidoc @mypackage.txt
• options 命令行选项。javadoc使用doclets（doclets是指用doclet API编写的程序。）来确定输出的内容和格式。命令行选项中一部分是可用于所有doclet的通用选项，一部分是由默认的标准doclet提供的专用的选 项。下面对各自一些常用的选项分别进行介绍：
通用选项：
◇ -1.1 生成具有javadoc 1.1版本生成的文档的外观和功能的文档。不是所有的选项都可以用于-1.1选项，具体可以使用javadoc -1.1 -help察看。
◇ -help 显示联机帮助。
◇ -bootclasspath classpathlist 指定"根类"（通常是Java平台自带的一些类。例如java.awt.*等）的路径。
◇ -sourcepath sourcepathlist 指定包的源文件搜索路径。但是必须注意，只有在javadoc命令中指定了包名的时候才可以使用-sourcepath选项。如果指定了包名，而省略了- sourcepath，那么javadoc使用类路径查找源文件。举例说明：假定你打算为com.mypackage建立文档，其源文件的位置是C: usersrc。那么你可以使用下面的命令：
javadoc -sourcepath c:usersrc com.mypackage
◇ -classpath classpathlist 指定javadoc查找"引用类"的路径。引用类是指带文档的类加上它们引用的任何类。javadoc将搜索指定路径的所有子目录。 Classpathlist可以包含多个路径（使用;隔开）。如果省略-classpath，则javadoc使用-sourcepath查找源文件和类 文件。举例说明：假定你打算为com.mypackage建立文档，其源文件的位置是C:usersrc，包依赖C:userlib中的库。那么你可以使 用下面的命令：
javadoc -classpath c:userlib -sourcepath c:usersrc com.mypackage
◇ -overview pathfilename 告诉javadoc从pathfilename所指定的文件中获取概述文档，并且把它放到输出的概述页面（overview-summary.html） 中。其中pathfilename是相对于-sourcepath的相对路径。
◇ -public 只显示公共类以及成员。
◇ -protected 只显示受保护的和公共的类以及成员。缺省选项。
◇ -package只显示包、受保护的和公共的类以及成员。
◇ -private 显示所有类和成员。
◇ -doclet class 指定javadoc产生输出内容的自定义doclet类。如果忽略这个选项，javadoc将使用默认的doclet产生一系列HTML文档。
◇ -docletpath classpathlist 与- doclet选项相关，制定自定义的doclet类文件的路径。Classpathlist可以包含多条路径（用;隔开）。
◇ -verbose 在javadoc运行时提供更详细的信息。
标准doclet专用选项：
◇ -author 在生成的文档中包含"作者"项。
◇ - d directory 指定javadoc保存生成的HTML文件的目录。省略该选项将把文件保存在当前目录。Directory可以是绝对目录，也可以是相对当前目录的相对目录。
◇ -version 在生成的文档中包含"版本"项。
◇ -use 为类和包生成"use"（用法）页面。这些页面描述了该类和包在javadoc命令涉及的文件中被使用的情况。例如：对于给定的类C，在C的用法页面中将包含C的子类，类型为C的域，返回变量类型为C的方法以及在参数中有变量类型为C的方法和构造器。
◇ -splitindex 把索引文件按照字母顺序分为多个文件。每一个文件对应一个字母。
◇ -windowtitle title 指定输出的HTML文档的标题。
◇ -header header 指定输出的HTML文档的页眉文本。
◇ -footer footer 指定输出的HTML文档的脚注文本。
◇ -bottom text 指定输出的HTML文档底部的文本。
◇ - group groupheading packagepatten;packagepatten;… 在总体概述页面中按照命令的指定方式分隔各个包。例如执行下面命令：
javadoc -group "Core Packages" "java.lang*:java.util"
-group "Extension Packages" "javax.*"
java.lang java.lang.reflect java.util javax.servlet java.new
在页面中将有如下结果：
Core Packages
java.lang
java.lang.reflect
java.util
Extension Packages
javax.servlet
Other Packages
java.new
◇ - noindex 不输出索引文件。
◇ - help 在文件的导航条中忽略help链接。
◇ - helpfile pathfilename 指定导航条中的help链接所指向的帮助文件。忽略该选项，javadoc将生成缺省的帮助文件。
◇ -stylesheetfile pathfilename 指定javadoc的HTML样式表文件的路径。忽略该选项，javadoc将自动产生一个样式表文件stylesheet.css。
JavaDoc文档标记
javadoc注释以"/**"开始，以"*/"结束，里面可以包含普通文本、HTML标记和javadoc标记。javadoc只处理源文件中在类/接口定义、方法、域、构造器之前的注释，忽略位于其他地方的注释。举例如下：
/**
*Demo--<b>Helloworld</b>
*@author sunjl
*@version 1.0 2001/10/15
*/
public class myHelloworld
{
/**
*在main( )方法中使用的显示用字符串
*@see #main(java.lang.String[])
*/
static String SDisplay;
/**
*显示HelloWorld
*@param args 从命令行中带入的字符串
*@return 无
*/
public static void main(String args[])
{
SDisplay = "Hello World " ;
System.out.println( SDisplay );
}
}
使用下面命令：
javadoc -private -d doc -author -version myHelloworld.java
即可以生成漂亮的关于myHelloworld.java的API文档了。
上面例子中以@开头的标记就是javadoc标记。在Java程序中正确使用javadoc标记是一个良好的注释习惯，将非常有助于javadoc自动从源代码文件生成完整的格式化API文档。下面就对各种标记进行详细说明。
◇ @author name-text 指定生成文档中的"作者"项，从JDK/SDK 1.0开始引入。name-text可以指定多个名字（使用","隔开）。文档注释可以包含多个类。
◇ {@docroot} 代表产生文档的根路径，从JDK/SDK 1.3开始引入。用法举例如下
/**
*see the <a href={@docroot}/copyright.html>copyright</a>
*/
假定生成文档的根目录是doc，上面注释所在的文件最后生成的文件是docutilityutl.html，那么"copyright"的链接会指向..copyright.html。
◇ @deprecated deprecated-text 添加注释，表明不推荐使用该API。
◇ @exception class-name description @throw的同义标记，从JDK/SDK 1.0开始引入。
◇ {@link package.class#member label} 插入指向package.class#member的内嵌链接，从JDK/SDK 1.2开始引入。举例说明，假定注释中有如下文档：
/** Use the {@link #getComponentAt(int, int) getComponentAt} method. */
那么javadoc最终生成的HTML页面中将有如下内容
Use the <a href = "Component.html#getComponentAt(int,int)" > getComponentAt </a> method.
◇ @param parameter-name description 描述参数，从JDK/SDK 1.0开始引入。
◇ @return description 描述返回值，从JDK/SDK 1.0开始引入。
◇ @see reference 添加"参见"标题，其中有指向reference的链接或者文本项，从JDK/SDK 1.0开始引入。@see标记有三种形式，下面分别说明：
（1）、@see "string" 为"string"添加文本项，不产生链接。
（2）、@see <a href="URL#Value">Label</a> 使用HTML标记产生链接
（3）、@see package.class#member Label 使用Java语言的名字package.class #member产生链接。
◇ @serial field-description 用于缺省可序列化域的注释，从JDK/SDK 1.2开始引入。
◇ @serialField field-name field-type field-description 建立Serializable类的serialPersistentFields成员的ObjectStreamField组件的文档，从JDK/SDK 1.2开始引入。
◇ @serialData data-description data-description建立数据序列和类型的文档，从JDK/SDK 1.2开始引入。
◇ @since since-text 利用since-text内容为文档增加"since"标题，从JDK/SDK 1.1开始引入。
◇ @throws class-name description 与@exception同义。用class-name和description为输出文档添加"抛出"标题，从JDK/SDK 1.2开始引入。
◇ @version version-text 添加"版权"标题，从JDK/SDK 1.0开始引入。
上面介绍了标准doclet提供的所有标记。不过，需要注意这些标记的使用是有位置限制的。其中可以出现在类或者接口文档注释中的标记有：@see、 {@link}、@since、@deprecated、@author、@version。可以出现在方法或者构造器文档注释中的标记有：@see、 {@link}、@since、@deprecated、@param、@return、@throws、@exception、 @serialData。可以出现在域文档注释中的有：@see、{@link}、@since、@desprecated、@serial、 @serialField。
除了javadoc自身提供的标准标记以外，我们可以定制自己的标记吗？当然可以。只需要对javadoc标准的doclet程序进行扩充即可。实际上， 利用javadoc提供的doclet API，不仅可以扩充doclet标记，甚至还可以改变javadoc的整个输出。为了满足需要，你可以使javadoc输出普通文本、XML文件等。由 于扩充doclet涉及到Java编程，本文不再做深入介绍。
总之，javadoc提供了完整规范的API文档功能。在软件项目管理中，合理地使用javadoc不仅可以减少开发时的文档工作量，提高效率；而且还非常有利于将来软件的修改和维护。
JavaDoc 书写规范：
1、 File Header Comments : 每个文件都应该加上文件头标记，包括文件名、修改历史、版权信息和附加信息。例如：
/**
* @(#)demo.java 1.00 2002/05/27
*
* Copyright (c) 2000-2002 中国平安保险股份有限公司 版权所有
* Ping An Insurance Company of China. All rights reserved.
* This software is the confidential and proprietary
* information of Ping An Insurance Company of China.
* ("Confidential Information"). You shall not disclose
* such Confidential Information and shall use it only
* in accordance with the terms of the contract agreement
* you entered into with Ping An.
*/
2、class description:类信息，概括的描述类的功能和实现。
/** class description
*/
3、Variable Description:描述变量的意义和取值含义。
/** var variable description
*/
4、Method Description:标明每个方法的输入、输出参数和返回值类型，说明特殊变量取值的含义。相关类文档链接。
/** method description
* @param var signification
* @exception exception class name
* @return return_value return signification
*/
5、Association Description:关联类文档描述，在注释当中需要参引其它文档描述的地方，可在相应的注释当中如下插入：
/** method description
* @param var signification
* @exception exception class name
* @return return_value return signification
* @see package.class#member label
*/
6、包描述文件：概括描述包的功能和设计概要。为每个包创建一个描述文件，命名为package.html，与包的java文件放在一起。
注：javadoc生成文档时，会将该html文件的第一句放在package summary中，而把整个内容放在Overview summary中
JAVADOC 转 CHM
现在比较流行的工具是JavadocToCHM
在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。
在Javadoc Generation对话框中有两个地方要注意的：
javadoc command:应该选择jdk的bin/javadoc.exe
destination:为生成文档的保存路径，可自由选择。
按finish(完成)提交即可开始生成文档。
方法2：命令行方式生成
javadoc的命令行语法如下：
javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]
参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明：
• Packagenames 包列表。这个选项可以是一系列的包名（用空格隔开），例如java.lang java.lang.reflect java.awt。不过，因为javadoc不递归作用于子包，不允许对包名使用通配符；所以你必须显示地列出希望建立文档的每一个包。
• Sourcefiles 源文件列表。这个选项可以是一系列的源文件名（用空格隔开），可以使用通配符。javadoc允许四种源文件：类源代码文件、包描述文件、总体概述文件、其他杂文件。
◇ 类源代码文件：类或者接口的源代码文件。
◇ 包描述文件：每一个包都可以有自己的包描述文件。包描述文件的名称必须是"package.html"，与包的.java文件放置在一起。包描述文件的内 容通常是使用HTML标记写的文档。javadoc执行时将自动寻找包描述文件。如果找到，javadoc将首先对描述文件中<body> </body>之间的内容进行处理，然后把处理结果放到该包的Package Summary页面中，最后把包描述文件的第一句（紧靠<body>）放到输出的Overview summary页面中，并在语句前面加上该包的包名。
◇ 总体概述文件：javadoc可以创建一个总体概述文件描述整个应用或者所有包。总体概述文件可以被任意命名，也可以放置到任意位置。-overview 选项可以指示总体概述文件的路径和名称。总体概述文件的内容是使用HTML标记写的文档。javadoc在执行的时候，如果发现-overview选项， 那么它将首先对文件中<body></body>之间的内容进行处理；然后把处理后的结果放到输出的Overview summary 页面的底部；最后把总体概述文件中的第一句放到输出的Overview summary页面的顶部。
◇ 其他杂文件：这些文件通常是指与javadoc输出的HTML文件相关的一些图片文件、Java源代码文件（.java）、Java程序 （.class）、Java小程序（Applets）、HTML文件。这些文件必须放在doc-files目录中。每一个包都可以有自己的doc- files目录。举个例子，你希望在java.awt.Button的HTML文档中使用一幅按钮的图片（Button.gif）。首先，你必须把图片文 件放到C:usersrcjavaawtdoc-files中；然后在Button.java文件中加入下面注释
/**
* This button looks like this:
* <img src="doc-files/Button.gif">
*/
• @files 包含文件。为了简化javadoc命令，你可以把需要建立文档的文件名和包名放在一个或多个文本文件中。例如，为了简化下面命令：
javadoc -d apidoc com.mypackage1 com.mypackage2 com.mypackage3
你可以建立一个名称为mypackage.txt的文件，其内容如下：
com.mypackage1
com.mypackage2
com.mypackage3
然后执行下面命令即可：
javadoc -d apidoc @mypackage.txt
• options 命令行选项。javadoc使用doclets（doclets是指用doclet API编写的程序。）来确定输出的内容和格式。命令行选项中一部分是可用于所有doclet的通用选项，一部分是由默认的标准doclet提供的专用的选 项。下面对各自一些常用的选项分别进行介绍：
通用选项：
◇ -1.1 生成具有javadoc 1.1版本生成的文档的外观和功能的文档。不是所有的选项都可以用于-1.1选项，具体可以使用javadoc -1.1 -help察看。
◇ -help 显示联机帮助。
◇ -bootclasspath classpathlist 指定"根类"（通常是Java平台自带的一些类。例如java.awt.*等）的路径。
◇ -sourcepath sourcepathlist 指定包的源文件搜索路径。但是必须注意，只有在javadoc命令中指定了包名的时候才可以使用-sourcepath选项。如果指定了包名，而省略了- sourcepath，那么javadoc使用类路径查找源文件。举例说明：假定你打算为com.mypackage建立文档，其源文件的位置是C: usersrc。那么你可以使用下面的命令：
javadoc -sourcepath c:usersrc com.mypackage
◇ -classpath classpathlist 指定javadoc查找"引用类"的路径。引用类是指带文档的类加上它们引用的任何类。javadoc将搜索指定路径的所有子目录。 Classpathlist可以包含多个路径（使用;隔开）。如果省略-classpath，则javadoc使用-sourcepath查找源文件和类 文件。举例说明：假定你打算为com.mypackage建立文档，其源文件的位置是C:usersrc，包依赖C:userlib中的库。那么你可以使 用下面的命令：
javadoc -classpath c:userlib -sourcepath c:usersrc com.mypackage
◇ -overview pathfilename 告诉javadoc从pathfilename所指定的文件中获取概述文档，并且把它放到输出的概述页面（overview-summary.html） 中。其中pathfilename是相对于-sourcepath的相对路径。
◇ -public 只显示公共类以及成员。
◇ -protected 只显示受保护的和公共的类以及成员。缺省选项。
◇ -package只显示包、受保护的和公共的类以及成员。
◇ -private 显示所有类和成员。
◇ -doclet class 指定javadoc产生输出内容的自定义doclet类。如果忽略这个选项，javadoc将使用默认的doclet产生一系列HTML文档。
◇ -docletpath classpathlist 与- doclet选项相关，制定自定义的doclet类文件的路径。Classpathlist可以包含多条路径（用;隔开）。
◇ -verbose 在javadoc运行时提供更详细的信息。
标准doclet专用选项：
◇ -author 在生成的文档中包含"作者"项。
◇ - d directory 指定javadoc保存生成的HTML文件的目录。省略该选项将把文件保存在当前目录。Directory可以是绝对目录，也可以是相对当前目录的相对目录。
◇ -version 在生成的文档中包含"版本"项。
◇ -use 为类和包生成"use"（用法）页面。这些页面描述了该类和包在javadoc命令涉及的文件中被使用的情况。例如：对于给定的类C，在C的用法页面中将包含C的子类，类型为C的域，返回变量类型为C的方法以及在参数中有变量类型为C的方法和构造器。
◇ -splitindex 把索引文件按照字母顺序分为多个文件。每一个文件对应一个字母。
◇ -windowtitle title 指定输出的HTML文档的标题。
◇ -header header 指定输出的HTML文档的页眉文本。
◇ -footer footer 指定输出的HTML文档的脚注文本。
◇ -bottom text 指定输出的HTML文档底部的文本。
◇ - group groupheading packagepatten;packagepatten;… 在总体概述页面中按照命令的指定方式分隔各个包。例如执行下面命令：
javadoc -group "Core Packages" "java.lang*:java.util"
-group "Extension Packages" "javax.*"
java.lang java.lang.reflect java.util javax.servlet java.new
在页面中将有如下结果：
Core Packages
java.lang
java.lang.reflect
java.util
Extension Packages
javax.servlet
Other Packages
java.new
◇ - noindex 不输出索引文件。
◇ - help 在文件的导航条中忽略help链接。
◇ - helpfile pathfilename 指定导航条中的help链接所指向的帮助文件。忽略该选项，javadoc将生成缺省的帮助文件。
◇ -stylesheetfile pathfilename 指定javadoc的HTML样式表文件的路径。忽略该选项，javadoc将自动产生一个样式表文件stylesheet.css。
JavaDoc文档标记
javadoc注释以"/**"开始，以"*/"结束，里面可以包含普通文本、HTML标记和javadoc标记。javadoc只处理源文件中在类/接口定义、方法、域、构造器之前的注释，忽略位于其他地方的注释。举例如下：
/**
*Demo--<b>Helloworld</b>
*@author sunjl
*@version 1.0 2001/10/15
*/
public class myHelloworld
{
/**
*在main( )方法中使用的显示用字符串
*@see #main(java.lang.String[])
*/
static String SDisplay;
/**
*显示HelloWorld
*@param args 从命令行中带入的字符串
*@return 无
*/
public static void main(String args[])
{
SDisplay = "Hello World " ;
System.out.println( SDisplay );
}
}
使用下面命令：
javadoc -private -d doc -author -version myHelloworld.java
即可以生成漂亮的关于myHelloworld.java的API文档了。
上面例子中以@开头的标记就是javadoc标记。在Java程序中正确使用javadoc标记是一个良好的注释习惯，将非常有助于javadoc自动从源代码文件生成完整的格式化API文档。下面就对各种标记进行详细说明。
◇ @author name-text 指定生成文档中的"作者"项，从JDK/SDK 1.0开始引入。name-text可以指定多个名字（使用","隔开）。文档注释可以包含多个类。
◇ {@docroot} 代表产生文档的根路径，从JDK/SDK 1.3开始引入。用法举例如下
/**
*see the <a href={@docroot}/copyright.html>copyright</a>
*/
假定生成文档的根目录是doc，上面注释所在的文件最后生成的文件是docutilityutl.html，那么"copyright"的链接会指向..copyright.html。
◇ @deprecated deprecated-text 添加注释，表明不推荐使用该API。
◇ @exception class-name description @throw的同义标记，从JDK/SDK 1.0开始引入。
◇ {@link package.class#member label} 插入指向package.class#member的内嵌链接，从JDK/SDK 1.2开始引入。举例说明，假定注释中有如下文档：
/** Use the {@link #getComponentAt(int, int) getComponentAt} method. */
那么javadoc最终生成的HTML页面中将有如下内容
Use the <a href = "Component.html#getComponentAt(int,int)" > getComponentAt </a> method.
◇ @param parameter-name description 描述参数，从JDK/SDK 1.0开始引入。
◇ @return description 描述返回值，从JDK/SDK 1.0开始引入。
◇ @see reference 添加"参见"标题，其中有指向reference的链接或者文本项，从JDK/SDK 1.0开始引入。@see标记有三种形式，下面分别说明：
（1）、@see "string" 为"string"添加文本项，不产生链接。
（2）、@see <a href="URL#Value">Label</a> 使用HTML标记产生链接
（3）、@see package.class#member Label 使用Java语言的名字package.class #member产生链接。
◇ @serial field-description 用于缺省可序列化域的注释，从JDK/SDK 1.2开始引入。
◇ @serialField field-name field-type field-description 建立Serializable类的serialPersistentFields成员的ObjectStreamField组件的文档，从JDK/SDK 1.2开始引入。
◇ @serialData data-description data-description建立数据序列和类型的文档，从JDK/SDK 1.2开始引入。
◇ @since since-text 利用since-text内容为文档增加"since"标题，从JDK/SDK 1.1开始引入。
◇ @throws class-name description 与@exception同义。用class-name和description为输出文档添加"抛出"标题，从JDK/SDK 1.2开始引入。
◇ @version version-text 添加"版权"标题，从JDK/SDK 1.0开始引入。
上面介绍了标准doclet提供的所有标记。不过，需要注意这些标记的使用是有位置限制的。其中可以出现在类或者接口文档注释中的标记有：@see、 {@link}、@since、@deprecated、@author、@version。可以出现在方法或者构造器文档注释中的标记有：@see、 {@link}、@since、@deprecated、@param、@return、@throws、@exception、 @serialData。可以出现在域文档注释中的有：@see、{@link}、@since、@desprecated、@serial、 @serialField。
除了javadoc自身提供的标准标记以外，我们可以定制自己的标记吗？当然可以。只需要对javadoc标准的doclet程序进行扩充即可。实际上， 利用javadoc提供的doclet API，不仅可以扩充doclet标记，甚至还可以改变javadoc的整个输出。为了满足需要，你可以使javadoc输出普通文本、XML文件等。由 于扩充doclet涉及到Java编程，本文不再做深入介绍。
总之，javadoc提供了完整规范的API文档功能。在软件项目管理中，合理地使用javadoc不仅可以减少开发时的文档工作量，提高效率；而且还非常有利于将来软件的修改和维护。
JavaDoc 书写规范：
1、 File Header Comments : 每个文件都应该加上文件头标记，包括文件名、修改历史、版权信息和附加信息。例如：
/**
* @(#)demo.java 1.00 2002/05/27
*
* Copyright (c) 2000-2002 中国平安保险股份有限公司 版权所有
* Ping An Insurance Company of China. All rights reserved.
* This software is the confidential and proprietary
* information of Ping An Insurance Company of China.
* ("Confidential Information"). You shall not disclose
* such Confidential Information and shall use it only
* in accordance with the terms of the contract agreement
* you entered into with Ping An.
*/
2、class description:类信息，概括的描述类的功能和实现。
/** class description
*/
3、Variable Description:描述变量的意义和取值含义。
/** var variable description
*/
4、Method Description:标明每个方法的输入、输出参数和返回值类型，说明特殊变量取值的含义。相关类文档链接。
/** method description
* @param var signification
* @exception exception class name
* @return return_value return signification
*/
5、Association Description:关联类文档描述，在注释当中需要参引其它文档描述的地方，可在相应的注释当中如下插入：
/** method description
* @param var signification
* @exception exception class name
* @return return_value return signification
* @see package.class#member label
*/
6、包描述文件：概括描述包的功能和设计概要。为每个包创建一个描述文件，命名为package.html，与包的java文件放在一起。
注：javadoc生成文档时，会将该html文件的第一句放在package summary中，而把整个内容放在Overview summary中
JAVADOC 转 CHM
现在比较流行的工具是JavadocToCHM
分享到：
发表评论
-
Android 修改Android签名证书keystore的密码、别名alias以及别名的密码
2015-04-27 10:35 1250转载请注明出处：http://blog.csdn.net/ ... -
基本HTTP请求回顾
2014-12-24 11:40 932HttpURLConnection为javaAPI提供的一种R ... -
Android签名验证简介
2014-05-16 10:15 5388Android原生自带了个安装器（packages\apps ... -
正则表达式大全
2014-03-18 17:05 1018正则表达式匹配网址： (https://[\w]*.|http ... -
正则表达式大全
2014-03-18 16:53 0正则表达式匹配网址： (https://[\w]*.|http ... -
jni jstring 、char* 类型的转换
2014-03-06 18:20 849jni jstring 、char* 类型的转换 //jst ... -
基于 Android NDK 的学习之旅-----资源释放
2014-01-11 14:37 1138转载于http://www.cnblogs.com ... -
Android系统手机端抓包方法
2013-06-25 11:42 1019抓包准备 1. Android手机需要先获得root权限。 ... -
Android捕获异常
2013-04-03 14:52 1071如果有些异常是运行时异常，你无法捕获，但是又不想让程序 ... -
JAVA比较器报错：Comparison method violates its general contract
2013-02-05 13:03 13860java.lang.IllegalArgumentExcept ... -
java.lang.IllegalStateException: tried to write 1544 bytes with content-length
2013-01-31 14:57 1423上传文件时,content-length定义的长度小于 ... -
eclipse 开导入android 第三方jar包java heap space问题解决
2013-01-22 17:25 2523最近做android应用需要使用第三方的jar包，结果导入到e ... -
Java MD5加密
2012-12-03 15:01 911import java.security.*; imp ... -
解决android网络异常java.net.SocketException: Bad address family
2012-10-22 11:28 3249在Android系统中进行网络开发时，如果使用了java.ni ... -
怎么让JButton的大小适应图片的大小
2012-10-09 18:36 4436可以自己来设置大小： ImageIcon icon = new ... -
Android开发进阶之NIO非阻塞包(八)
2012-09-25 15:59 0在整个DDMS中体现Android NIO主要框架的要数Mon ... -
Android开发进阶之NIO非阻塞包(七)
2012-09-25 15:58 0今天我们继续就Android DDMS源码一起分析NIO非阻塞 ... -
Android开发进阶之NIO非阻塞包(六)
2012-09-25 15:58 0有关Android NIO的相关内容，本次Android123 ... -
Android开发进阶之NIO非阻塞包(五)
2012-09-25 15:56 1065有关Android NIO的注意点和重点今天Android12 ... -
Android开发进阶之NIO非阻塞包(四)
2012-09-25 15:55 1107今天我们通过一个实例详细讲解下Android下NIO非阻塞服务 ...
相关推荐
JavaDoc生成API文档（powernode document）（内含源代码和导出的文档） 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 vaDoc是Java自带的一种工具，其可以从程序源代码中抽取类、方法、属性等注释形成一...
4. **设置Javadoc生成参数**：在“Javadoc Generation”界面中，你可以设置多种参数来定制生成的文档。这些参数包括但不限于： - **Javadoc Command**：指定Javadoc的执行路径，默认情况下，应指向你的JDK安装目录...
2.1JavaDoc生成方法 在eclipse中生成,在项目列表中按右键，选择Export（导出）然后在Export(导出)对话框中选择java下的javadoc，提交到下一步.在Javadoc Generation对话框中有两个地方要注意的： javadoc command:...
这个工具可能实现了将JavaDoc生成的HTML文件转换为CHM文件的流程，从而使得Java项目的API文档更适合在Windows环境中查看，尤其是对于那些不习惯阅读HTML的开发者而言，CHM的搜索和索引功能更友好。 要使用这个工具...
Javadoc生成文档的依据是源代码中的文档注释，即以`/**`开头，`*/`结尾的注释块。这种注释可以包含多行文本，并支持HTML格式化标记，如斜体`<i>`、粗体`<b>`和等宽字体`<code>`，但应避免使用如`<title>`和`<hr>`等...
**Javadoc详解与生成方法** Javadoc是一种在Java编程语言中用于生成API文档的工具，它能够自动提取源代码中的注释，形成清晰、结构化的文档，方便开发者理解和使用代码库。本文将深入探讨Javadoc的基本概念、语法、...
javadoc 帮助文档的生成 javadoc 帮助文档的生成是 Java 开发者必备的技能之一。通过使用 JDK 提供的 javadoc.exe 工具，可以生成帮助文档，并备注了代码，可以参考注释的书写格式。今天，我们将详细介绍 javadoc ...
第三种方法是选中要生成文档的项目，然后用菜单选择Project->Generate Javadoc直接进入Javadoc Generation对话框，剩余的步骤就和第一种方法中的Javadoc Generation是一样的。 在使用javadoc命令生成javadoc文档时...
Eclipse中自动生成Javadoc的方法，以及一些标签的含义
`javadoc生成chm工具`是为了将JavaDoc生成的HTML文档转换为CHM文件，使得用户可以更方便地在离线环境下查阅Java API。这种工具简化了这个过程，无需手动操作多个文件，只需要简单的步骤就能完成转换。 **一、...
3. **结果**：生成的HTML文档将按照类层次结构组织，每个类、接口或方法都有详细的页面，展示其JavaDoc注释。 除了基本的`/**...*/`注释形式，JavaDoc还支持以下特殊标签： - `@param` 描述方法参数。 - `@return` ...
针对于有需要控制JavaDoc生成内容的需求。对于使用了自定义注解的类才生成JavaDoc。且支持类和方法两个粒度。在类上使用就生成整个类的，在方法上生成就生成单个方法的。配合gradle task使用，具体代码可见本人博客...
JavaDoc生成API文档（powernode CD2207）(内含教学视频+源代码) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 JavaDoc是Java自带的一种工具，其可以从程序源代码中抽取类、方法、属性等注释形成一个和源...
这一段时间在研究Javadoc的问题，前面发布的Javadoc转换chm帮助文档的四种方法总结，总结了如何实现Javadoc到chm的转换，希望给大家带来了一些方便，今天我们来说说如何利用Eclipse生成个性化的Javadoc 文档，也希望...
能够使用Javadoc生成OpenAPI规范的文档 要使用此功能，请确保在您的spring上下文中找到了JavadocPluginConfiguration ，并将javadoc doclet的执行添加到您的构建过程中。 Maven的例子： < groupId>org.apache....
Maven插件，用于从JAX-RS和Javadoc注释生成Swagger 这个Maven插件正在为基于JAX-RS的Java服务器生成Swagger API文档。 JAX-RS批注中未包含的其他信息放置在Javadoc注释中。 例 此处提供了一个使用javadoc2swagger-...
hibernate@注解方式配置实体...实体类getter方法上需要用javadoc方式写注释说明，如： /** * 生成时间backup_time */ @Column(name = "backup_time") public Timestamp getBackupTime() { return this.backupTime; }
JavaDoc是Java编程语言中的一个工具，用于从源代码注释中自动生成API文档。它通过解析源代码文件中的特殊注释格式，如`@param`, `@return`, `@throws`, `@author`, `@version`等，来构建一份详细、结构化的文档，...