JavaDOC注释使用方法_百度文库
两大类热门资源免费畅读
续费一年阅读会员，立省24元！
JavaDOC注释使用方法
阅读已结束，下载文档到电脑
想免费下载本文？
定制HR最喜欢的简历
下载文档到电脑，方便使用
还剩11页未读，继续阅读
定制HR最喜欢的简历
你可能喜欢下次自动登录
现在的位置:
& 综合 & 正文
JavaDoc注释 使用方法
Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。
Javadoc输出的是一些HTML文件，我们可以通过WEB浏览器来查看它。
Javadoc的语法：
所有Javadoc都只能源于/**开始和*/结束。使用javadoc有二种方式：一种是嵌入HTML；另一种是使用文档标签。所谓文档标签就是一些以 “@”开头的命令，且“@”要置于注释行的最前面。而“行内文档标签”则可以出现在Javadoc注释中的任何地方，它们也是以“@”字符开头，但要括在共括号内。
Javadoc只能为public或者protected成员进行文档注释。private和包内访问的成员的注释会被忽略掉。这样做是有道理的，因为只有public和protected成员才能在文件之外被使用，这也体现了封装性的优点。
嵌入HTML：
Javadoc将HTML代码嵌入到所生成的HTML文件中。这样能充分利用HTML的功能。比如：
但一般我们不要在HTML里使用标题，如&h1&&hr&，因为Javadoc会插入自己的标题，我们的标题可能会干扰它。
常用的标签：
1) @see：引用其它类的文档，相当于超链接，Javadoc会在其生成的HTML文件中，将@see标签链到其他的文档
@see classname
这样在生成的文档中会出现"See Also"的超链蛸。但是Javadoc不去检查你的超链接是否有效。
package.class#member label}
与@See的功能一样，只是用label作主超链接，而不是用"see also"
3) }：标签产生 到文档根目录的相对路径，用于文档树页面的显式超链接
4) }：标签从当前这个类的最直接的基类中继承相关文档到当前的文档注释中。
5) @version：使用方法为@version 2.2.1.2...
2.2.1.2...是我们作的版本说明信息
6) @author：使用方法为 @author PowerFedora
也就是说我们可以在@author后加上作者名字，email等联系方式
7) @since：这个标签允许你指定程序最早使用的版本。
比如我们看JDK Document里的每个类最后都会说明从JDK哪个版本开始启用。
8) @param：@param name 用于输入客户的姓名
@param后面是方法的参数，以及相应的说明
我们可以使用任意数量的此标签，每个参数都可以有这样一个标签
9) @return this is description
@return后面是描述返回值的含义，可以延续几行。
10) @throws fully-qualified-class-name description
fully-qualified-class-name为异常类的完整名字，
而description告诉你为什么此异常会在方法中调用出现。
11) @deprecated：用于指出一些旧特性已由改进的新特性所取代，建议用户不要再使用旧特性。
import java.util.*;
public class JavaDocTest {
public static void main(String[] args){
System.out.print("HelloWorld!");
如果使用eclipse的话，完全不需要背这些标签。在需要注释的地方打上/**之后，再打@符号eclipse会自动显示所支持的标签供选择。
同样在生成HTML文档时也可以利用eclipse的export功能直接导出，否则用javadoc手工来生成的话是件相当痛苦的事情。
1.编写一小段程序，体会文档注释的用法，并通过文档生成工具提取文档注释，形成程序文档。
代码如下：
import java.util.*;
public class Property {
public static void main(String args[]) {
System.out.println(new Date());
System.getProperties().list(System.out);
System.out.println("--- Memory Usage：");
Runtime rt = Runtime.getRuntime();
System.out.println("Total Memory = "
+ rt.totalMemory()
+ " Free Memory = "
+ rt.freeMemory());
利用Myeclipse生产javadoc文档的步骤如下：
1.选择File-&Export-&javadoc，下一步。
2.Javadoc comand选择JDK的bin目录下的javadoc.exe。选择要生成的源代码和javadoc保存的目的路径，下一步。
3.Document title输入标题，下一步。
4.overview输入启动指定的overview文件路径，Extra Javadoc options输入
-windowtitle 'Type B Monitor'[浏览器显示标题]
-bottom &center&Travelsky&/center&[底部显示文本]，下一步。
&&&&推荐文章:
【上篇】【下篇】javadoc中的@see超链接怎么做呀？我在注释里写了@see+类名，但是生成的html文档里，类名没有生成超链接！_百度知道
javadoc中的@see超链接怎么做呀？我在注释里写了@see+类名，但是生成的html文档里，类名没有生成超链接！
请把具体操作写下来！
使用java是无法自动生成注释的。最多生成注释的空壳。例如在eclipse可以用alt-shift-j，生成一个空的注释框架。 具体的内容还是需要开发者自己来实现的。现在代码还没有灵活到通过看你的代码了解你要做什么。另外一种生成注释的方法则是反过来，自动生成代码的同时自动生成注释。一般使用伪代码工具来编写，然后在生成代码的同时生成java。这样的工具不多。而且往往有很大的局限。往往属于公司内部使用的工具。
采纳率：98%
来自团队：
@see 标签允许用户引用其他类的文档。@see classname@see fully-qualified-classname@see fully-qualified-classname#method-name
我是这么写的啊！但是文档里面没有生成超链接呀！链接的类也要生成文档吗？还有什么要注意的？
本回答被网友采纳
为您推荐：
其他类似问题
javadoc的相关知识
换一换
回答问题，赢新手礼包
个人、企业类
违法有害信息,请在下方选择后提交
色情、暴力
我们会通过消息、邮箱等方式尽快将举报结果通知您。Javadoc—Java的注释之美 - u的专栏 - CSDN博客
Javadoc—Java的注释之美
写java程序里的注释是很有学问的--很遗憾我今天才发现,更遗憾的是现一堆的程序需要我重新来做调整及添加注释,后悔一开始做程序时就没有个好的规划,现在修改起来真是个工作量很大的事,突然觉得这也类似于蝴蝶效应,一点小的事演化累积之后会造成的后果是不可估量的.另外,在此不提不提及的是,感谢Sun公司的javadoc这个好工具!那下面来看看该如何写注释吧.
&&&(以下为转载)
&&&对于Java语言，最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。对于程序的文档化，最大的问题莫过于对文档的维护。若文档与代码分离，那么每次改变代码后都要改变文档，这无疑会变成相当麻烦的一件事情。解决的方法看起来似乎很简单：将代码同文档“链接”起来。为达到这个目的，最简单的方法是将所有内容都置于同一个文件。然而，为使一切都整齐划一，还必须使用一种特殊的注释语法，以便标记出特殊的文档；另外还需要一个工具，用于提取这些注释，并按有价值的形式将其展现出来。这些都是Java必须做到的。
&&&&用于提取注释的工具叫作javadoc。它采用了部分来自Java编译器的技术，查找我们置入程序的特殊注释标记。它不仅提取由这些标记指示的信息，也将毗邻注释的类名或方法名提取出来。这样一来，我们就可用最轻的工作量，生成十分专业的程序文档。
&&&&javadoc输出的是一个HTML文件，可用自己的Web浏览器查看。该工具允许我们创建和管理单个源文件，并生动生成有用的文档。由于有了jvadoc，所以我们能够用标准的方法创建文档。而且由于它非常方便，所以我们能轻松获得所有Java库的文档。
2 具体语法
&&&&所有javadoc命令都只能出现于“”。主要通过两种方式来使用javadoc：嵌入的HTML，或使用“文档标记”。其中，“文档标记”（Doc tags）是一些以“@”开头的命令，置于注释行的起始处（但前导的“*”会被忽略）。
有三种类型的注释文档，它们对应于位于注释后面的元素：类、变量或者方法。也就是说，一个类注释正好位于一个类定义之前；变量注释正好位于变量定义之前；而一个方法定义正好位于一个方法定义的前面。如下面这个简单的例子所示：
public class docTest {
public void f() {}
注意javadoc只能为public（公共）和protected（受保护）成员处理注释文档。“private”（私有）和“友好”（详见5章）成员的注释会被忽略，我们看不到任何输出（也可以用-private标记包括private成员）。这样做是有道理的，因为只有public和protected成员才可在文件之外使用，这是客户程序员的希望。然而，所有类注释都会包含到输出结果里。
上述代码的输出是一个HTML文件，它与其他Java文档具有相同的标准格式。因此，用户会非常熟悉这种格式，可在您设计的类中方便地“漫游”。设计程序时，请务必考虑输入上述代码，用javadoc处理一下，观看最终HTML文件的效果如何。
3 嵌入HTML
javadoc将HTML命令传递给最终生成的HTML文档。这便使我们能够充分利用HTML的巨大威力。当然，我们的最终动机是格式化代码，不是为了哗众取宠。下面列出一个例子：
亦可象在其他Web文档里那样运用HTML，对普通文本进行格式化，使其更具条理、更加美观：
注意在文档注释中，位于一行最开头的星号会被javadoc丢弃。同时丢弃的还有前导空格。javadoc会对所有内容进行格式化，使其与标准的文档外观相符。不要将
这样的标题当作嵌入HTML使用，因为javadoc会插入自己的标题，我们给出的标题会与之冲撞。
所有类型的注释文档——类、变量和方法——都支持嵌入HTML。
4 @see：引用其他类
所有三种类型的注释文档都可包含@see标记，它允许我们引用其他类里的文档。对于这个标记，javadoc会生成相应的HTML，将其直接链接到其他文档。格式如下：
@see 完整类名
@see 完整类名
每一格式都会在生成的文档里自动加入一个超链接的“See Also”（参见）条目。注意javadoc不会检查我们指定的超链接，不会验证它们是否有效。
5 类文档标记
随同嵌入HTML和@see引用，类文档还可以包括用于版本信息以及作者姓名的标记。类文档亦可用于“接口”目的（本书后面会详细解释）。
1. @version
格式如下：
@version 版本信息
其中，“版本信息”代表任何适合作为版本说明的资料。若在javadoc命令行使用了“-version”标记，就会从生成的HTML文档里提取出版本信息。
2. @author
格式如下：
@author 作者信息
其中，“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在javadoc命令行使用了“-author”标记，就会专门从生成的HTML文档里提取出作者信息。
可为一系列作者使用多个这样的标记，但它们必须连续放置。全部作者信息会一起存入最终HTML代码的单独一个段落里。
6 变量文档标记
变量文档只能包括嵌入的HTML以及@see引用。
7 方法文档标记
除嵌入HTML和@see引用之外，方法还允许使用针对参数、返回值以及违例的文档标记。
格式如下：
@param 参数名 说明
其中，“参数名”是指参数列表内的标识符，而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记，就认为前一个说明结束。可使用任意数量的说明，每个参数一个。
2. @return
格式如下：
@return 说明
其中，“说明”是指返回值的含义。它可延续到后面的行内。
3. @exception
有关“违例”（Exception）的详细情况，我们会在第9章讲述。简言之，它们是一些特殊的对象，若某个方法失败，就可将它们“扔出”对象。调用一个方法时，尽管只有一个违例对象出现，但一些特殊的方法也许能产生任意数量的、不同类型的违例。所有这些违例都需要说明。所以，违例标记的格式如下：
@exception 完整类名 说明
其中，“完整类名”明确指定了一个违例类的名字，它是在其他某个地方定义好的。而“说明”（同样可以延续到下面的行）告诉我们为什么这种特殊类型的违例会在方法调用中出现。
4. @deprecated
这是Java 1.1的新特性。该标记用于指出一些旧功能已由改进过的新功能取代。该标记的作用是建议用户不必再使用一种特定的功能，因为未来改版时可能摒弃这一功能。若将一个方法标记为@deprecated，则使用该方法时会收到编译器的警告。
相关文章推荐