JavaDoc注释的使用跟导出JavaDoc文档

原创 2012年03月29日 14:27:59
1.Javadoc是什么:
 JavaDoc是Sun公司提供一种从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档技术,但是需要在编写程序时以一套特定的标签作注释,在程序编写完成
后,通过Javadoc就可以同时形成程序的开发文档了。Javadoc输出的是一些HTML文件,我们可以通过WEB浏览器来查看它。
2.Javadoc的语法:
所有Javadoc都只能源于/**开始和*/结束的注释,使用Javadoc有两种方式,一种是嵌入HTML,另一种是使用文档标签,所谓文档标签就是一些以"@"开头的命令,且"@"要置于注释行的最前面
,而“行内文档标签”则可以出现在Javadoc注释中的任何地方,它们也是以“@”字符开头,当要包括在共括号内。
Javadoc只能为public或者Protected成员惊醒文档注释,private和包内访问的成员注释会被忽略掉,因为只有public和protected成员才能在文件之外被使用,只要也体现了封装的有点。
嵌入HTML:
javadoc将HTML代码嵌入到所生成的HTML文件中,这样能充分利用HTML的功能,比如:
/**
*<b>
*this is my test application.
*</b>
*/
但一般我们不要在HTML里是同标题,如<h1><hr>,因为Javadoc会插入自己的标题,我们的标题可能会干扰它。
一些常见的标签:
1)@see:引用其他类的文档,相当于超链接,Javadoc会再其生成的HTML文件中,将@see变迁连接到其他的文档。
@see classname这样在生成的文档中会出现“See Also”的超链,但是Javadoc不去检查你的超链接是否有效。
2){@link package.class#memeber label}与@see的功能一样,只是用label作主超链接,而不是用“see also”。
3)@docRoot:标签产生到文档根目录的相对路径,用于文档树页面的显式超链接。
4)@inheritDoc:标签从当前这个类的最直接基类中继承相关问道到当前的文档注释中。
5)@version:使用方法@version 2.2.1.1...是我们做的版本信息说明。
6)@author:使用方法为@author后加上作者名字,email等联系方式。
7)@since:这个标签允许你指定程序最早使用的版本。比如我们看JDK Document里的每个类最后都会说明从JDK哪额版本开始启用。
8)@param:@param name 用户输入客户的姓名。@param后面是方法的参数,以及相应的说明,我们可以使用任意数量的此标签,每个参数都可以有这样一个标签。
9)@return 后面是描述返回值的含义,可以延续几行。
10)@throws fully-qualified-class-name description 为异常类的完整名字,而description告诉你为什么此异常会再方法调用中出现。
11)@deprecated:用于指出一些旧特性已由改进的新特性所取代,建议用户不要在使用旧特性。
使用eclipse工具生成Javadoc文档:
方法1.在项目列表中选中项目右键,选择Export(导出),然后在Export(导出)的对话框中选择java下的javadoc,转到下一步,在Javadoc Generation对话框中有两个地方要注意:
javadoc command:应该选择JDK安装目录下bin/javadoc.exe.
destination:生成文档的保存路径,自由选择保存路径。按finish即可来时生成文档。
方法2:在Eclipse菜单选择:File》Export(文件》导出),后续步骤跟方法1一致。
方法3:选中要生成文档的项目,然后用菜单选择,Project》Generate Javadoc直接进入Javadoc Generation对话框,后续步骤也跟方法1一致。
注:如果项目采用的UTF-8的编码,一定要在Extra Javadoc options选项中添加”-encoding UTF-8 -charset UTF-8",否则生成的网页中文注释都是乱码。 

1.Javadoc是什么:
 JavaDoc是Sun公司提供一种从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档技术,但是需要在编写程序时以一套特定的标签作注释,在程序编写完成
后,通过Javadoc就可以同时形成程序的开发文档了。Javadoc输出的是一些HTML文件,我们可以通过WEB浏览器来查看它。
2.Javadoc的语法:
所有Javadoc都只能源于/**开始和*/结束的注释,使用Javadoc有两种方式,一种是嵌入HTML,另一种是使用文档标签,所谓文档标签就是一些以"@"开头的命令,且"@"要置于注释行的最前面
,而“行内文档标签”则可以出现在Javadoc注释中的任何地方,它们也是以“@”字符开头,当要包括在共括号内。
Javadoc只能为public或者Protected成员惊醒文档注释,private和包内访问的成员注释会被忽略掉,因为只有public和protected成员才能在文件之外被使用,只要也体现了封装的有点。
嵌入HTML:
javadoc将HTML代码嵌入到所生成的HTML文件中,这样能充分利用HTML的功能,比如:
/**
*<b>
*this is my test application.
*</b>
*/
但一般我们不要在HTML里是同标题,如<h1><hr>,因为Javadoc会插入自己的标题,我们的标题可能会干扰它。
一些常见的标签:
1)@see:引用其他类的文档,相当于超链接,Javadoc会再其生成的HTML文件中,将@see变迁连接到其他的文档。
@see classname这样在生成的文档中会出现“See Also”的超链,但是Javadoc不去检查你的超链接是否有效。
2){@link package.class#memeber label}与@see的功能一样,只是用label作主超链接,而不是用“see also”。
3)@docRoot:标签产生到文档根目录的相对路径,用于文档树页面的显式超链接。
4)@inheritDoc:标签从当前这个类的最直接基类中继承相关问道到当前的文档注释中。
5)@version:使用方法@version 2.2.1.1...是我们做的版本信息说明。
6)@author:使用方法为@author后加上作者名字,email等联系方式。
7)@since:这个标签允许你指定程序最早使用的版本。比如我们看JDK Document里的每个类最后都会说明从JDK哪额版本开始启用。
8)@param:@param name 用户输入客户的姓名。@param后面是方法的参数,以及相应的说明,我们可以使用任意数量的此标签,每个参数都可以有这样一个标签。
9)@return 后面是描述返回值的含义,可以延续几行。
10)@throws fully-qualified-class-name description 为异常类的完整名字,而description告诉你为什么此异常会再方法调用中出现。
11)@deprecated:用于指出一些旧特性已由改进的新特性所取代,建议用户不要在使用旧特性。
使用eclipse工具生成Javadoc文档:
方法1.在项目列表中选中项目右键,选择Export(导出),然后在Export(导出)的对话框中选择java下的javadoc,转到下一步,在Javadoc Generation对话框中有两个地方要注意:
javadoc command:应该选择JDK安装目录下bin/javadoc.exe.
destination:生成文档的保存路径,自由选择保存路径。按finish即可来时生成文档。
方法2:在Eclipse菜单选择:File》Export(文件》导出),后续步骤跟方法1一致。
方法3:选中要生成文档的项目,然后用菜单选择,Project》Generate Javadoc直接进入Javadoc Generation对话框,后续步骤也跟方法1一致。
注:如果项目采用的UTF-8的编码,一定要在Extra Javadoc options选项中添加”-encoding UTF-8 -charset UTF-8",否则生成的网页中文注释都是乱码。


1.Javadoc是什么:
 JavaDoc是Sun公司提供一种从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档技术,但是需要在编写程序时以一套特定的标签作注释,在程序编写完成

后,通过Javadoc就可以同时形成程序的开发文档了。Javadoc输出的是一些HTML文件,我们可以通过WEB浏览器来查看它。
2.Javadoc的语法:
所有Javadoc都只能源于/**开始和*/结束的注释,使用Javadoc有两种方式,一种是嵌入HTML,另一种是使用文档标签,所谓文档标签就是一些以"@"开头的命令,且"@"要置于注释行的最前面

,而“行内文档标签”则可以出现在Javadoc注释中的任何地方,它们也是以“@”字符开头,当要包括在共括号内。
Javadoc只能为public或者Protected成员惊醒文档注释,private和包内访问的成员注释会被忽略掉,因为只有public和protected成员才能在文件之外被使用,只要也体现了封装的有点。
嵌入HTML:
javadoc将HTML代码嵌入到所生成的HTML文件中,这样能充分利用HTML的功能,比如:
/**
*<b>
*this is my test application.
*</b>
*/
但一般我们不要在HTML里是同标题,如<h1><hr>,因为Javadoc会插入自己的标题,我们的标题可能会干扰它。
一些常见的标签:
1)@see:引用其他类的文档,相当于超链接,Javadoc会再其生成的HTML文件中,将@see变迁连接到其他的文档。
@see classname这样在生成的文档中会出现“See Also”的超链,但是Javadoc不去检查你的超链接是否有效。
2){@link package.class#memeber label}与@see的功能一样,只是用label作主超链接,而不是用“see also”。
3)@docRoot:标签产生到文档根目录的相对路径,用于文档树页面的显式超链接。
4)@inheritDoc:标签从当前这个类的最直接基类中继承相关问道到当前的文档注释中。
5)@version:使用方法@version 2.2.1.1...是我们做的版本信息说明。
6)@author:使用方法为@author后加上作者名字,email等联系方式。
7)@since:这个标签允许你指定程序最早使用的版本。比如我们看JDK Document里的每个类最后都会说明从JDK哪额版本开始启用。
8)@param:@param name 用户输入客户的姓名。@param后面是方法的参数,以及相应的说明,我们可以使用任意数量的此标签,每个参数都可以有这样一个标签。
9)@return 后面是描述返回值的含义,可以延续几行。
10)@throws fully-qualified-class-name description 为异常类的完整名字,而description告诉你为什么此异常会再方法调用中出现。
11)@deprecated:用于指出一些旧特性已由改进的新特性所取代,建议用户不要在使用旧特性。

使用eclipse工具生成Javadoc文档:
方法1.在项目列表中选中项目右键,选择Export(导出),然后在Export(导出)的对话框中选择java下的javadoc,转到下一步,在Javadoc Generation对话框中有两个地方要注意:
javadoc command:应该选择JDK安装目录下bin/javadoc.exe.
destination:生成文档的保存路径,自由选择保存路径。按finish即可来时生成文档。
方法2:在Eclipse菜单选择:File》Export(文件》导出),后续步骤跟方法1一致。
方法3:选中要生成文档的项目,然后用菜单选择,Project》Generate Javadoc直接进入Javadoc Generation对话框,后续步骤也跟方法1一致。

注:如果项目采用的UTF-8的编码,一定要在Extra Javadoc options选项中添加”-encoding UTF-8 -charset UTF-8",否则生成的网页中文注释都是乱码。


 

相关文章推荐

android xml解析库选择

安卓常用的xml解析主要就是SAX(Simple API for XML)、DOM和Poll xmlpoll。 使用方法可以参考: http://www.cnblogs.com/devinzhan...

android解析XML总结(SAX、Pull、Dom三种方式)附带DOM4J、JDOM

摘要: 在android开发中,经常用到去解析xml文件,常见的解析xml的方式有一下三种:SAX、Pull、Dom解析方式。最近做了一个android版的CSDN阅读器,用到了其中的两种(sax,p...

javase Javadoc注释和生成文档

我们知道 Java 中有三种注释语句: 1.//用于单行注释。 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套。 3./**...*/则是为支持 jdk 工具 javad...

Eclipse中给jar包导入JavaDoc注释文档的方法

第一步:将jar加入到Referenced Libraries 右键点击jar --> 选择 Build Path --> Add to Build Path   第二步,设...
  • vaecer
  • vaecer
  • 2014年07月11日 14:48
  • 1031

JavaDoc注释 使用方法

Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Java...

Java IDE中设置作者日期等Javadoc注释信息

在Java的IDE(Integrated Development Environment,集成开发环境)中,如Eclipse、Spring Tool Suite、IntelliJ IDEA等,...
  • czh500
  • czh500
  • 2016年06月21日 19:38
  • 2884

JAVADOC注释详解

java注释的分类     1、单行注释:int SUM = 100; //这是一个单行注释     2、多行注释:     /*      *这是一个多行注释      */     3、文档注...

Javadoc注释标签语法

核心提示:javadoc可以根据项目代码的注释(当然是规范化的)自动生成HTML格式的API文档。 javadoc可以根据项目代码的注释(当然是规范化的)自动生成HTML格式的API文档。 ...
  • monimei
  • monimei
  • 2011年09月21日 00:25
  • 430

JAVAdoc注释

一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /*...

NetBeans为类生成javadoc注释

写本文的目的主要是为了编写较大的程序是
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:JavaDoc注释的使用跟导出JavaDoc文档
举报原因:
原因补充:

(最多只允许输入30个字)