关于 javadoc

javadoc可以帮助我们编写的代码生成相关的说明文档(API文档),这个参考官方的java API ,

通过你使用的javadoc标签,javadoc可以将你的程序中的相关api内容呈现出来,通过/**  */的方式将注释写入到javadoc文档中

一,java注释

// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行,并写入 javadoc 文档或者是这样写
/**
* .........
* .........
*/

只有第三种方式的注释会被写入到javadoc中

二、javadoc命令

javadoc -d 文档存放目录 -author -version 源文件名.java

javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version

-d 指定API文档的输出目录,默认是当前目录。建议总是指定该参数。
-sourcepath 指定源代码路径,默认是当前目录。 此参数通常是必须的。
-subpackages 以递归的方式处理各子包。关键参数!如果不使用本参数,每次只能处理一个子包(或需手工列出所有子包)。
-author 可以将作者信息(@author ***)导出到最终生成的API文档中
-version 可以生成版本信息。

这个命令生成html格式的API文档,文档中的相关内容都是通过用户写的注释和javadoc标记来实现的

三、javadoc注释的结构

第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明 
简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号)。换句话说,就是用第一个点号分隔文档注释,之前是简述,之后是第二部分和第三部分。
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。 
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
简述也在其中。这一点要记住了
第三部分是特殊说明部分,也就是javadoc标签。这部分包括版本说明、参数说明、返回值说明等。

/**
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
* @param b true 表示显示,false 表示隐藏
* @return 没有返回值
*/
public void show(boolean b) {
frame.show(b);
}

四、javadoc标签

@author 标明开发该类模块的作者 
@version 标明该类模块的版本 
@see+类名  参考转向,也就是相关主题 ,就是文档中的"另请参阅XXX"
@param 对方法中某参数的说明 
@return 对方法返回值的说明 
@exception 对方法可能抛出的异常进行说明 
五、其他

之前Annotation中,记得有一个@Documented的元注解,当一个注解被@Documented修饰的时候,这个注解会被写入到文档中。

时间: 2024-10-27 17:02:32

关于 javadoc的相关文章

初学JAVA随记——使用JAVADOC命令

1.控制台输入JAVADOC XXX.JAVA运行.JAVA文件. 2.双击文件夹下自动生成的index.html文件. 3.浏览器打开后即可显示. 注:Eclipse编写.JAVA文件,Tab键与源码下的“格式”可重排代码.

中文javadoc

大量的中文注释,其实最大的目的是想生成中文的Javadoc.但是中文注释实在太不高级了,在各种编码下还会变成乱码.本着高端大气国际化的思路,还是想把它换成英文,但是又不想放弃中文的Javadoc,怎么办呢? stackoverflow上有个帖子,说是在源码里写两种语言的注释,然后用过css切换.还有日本人用freemarker的语法来写Javadoc的http://www.ruimo.com/howto/java/javadoc-i18n/index_en.html.但是看到代码里一堆翻译文本也

Maven下载依赖项的源代码(source code)和Javadoc

Maven 默认只下载依赖项本身的 jar 文件,不下载源代码和 Javadoc.如此固然工程的体积是最小的,但在开发者不熟悉依赖的对象时,需要查找源代码中的方法定义和说明. 这时我们需要使用一条 Maven 命令将源代码和 Javadoc 下载到本地仓库. 代码清单 $ mvn dependency:sources -DdownloadSources=true -DdownloadJavadocs=true 该命令共两个参数,前者下载源代码,后者下载Javadoc.

Java - IntelliJ IDEA生成Javadoc

IntelliJ IDEA作为Java流行的编辑器, 其生成一些Javadoc会对中文乱码, 使用UTF-8编码即可. 这个常见的问题, 则需要生成时设置参数即可. 在 "Tools->Gerenate JavaDoc" 面版的 "Other command line arguments:" 栏里输入 "-encoding utf-8 -charset utf-8". 版权声明:本文为博主原创文章,未经博主允许不得转载.

读thinking in java的收获(二) --eclipse生成javadoc文档

最开始学习java语言的时候学过生成javadoc不过当时只是用windows命令行生成.读了这里的javadoc温故而知新发现其实我们做的项目就用到了一些注释,只是没有用eclipse 生成这份文档,通过查阅,最终补全了这份知识. 一.书中的代码: <pre name="code" class="java">//:object/HelloDate.java package unit2; import java.util.Date; /** * The

How to Write Doc Comments for the Javadoc Tool

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle. It does not rehash r

【转载】解决使用Eclipse中调用javadoc的问题

出处:http://blog.163.com/[email protected]/blog/static/6256726420096259420870/ 像Microsoft Visual Studio 一样,使用Eclipse编写java代码时,将鼠标放在相应方法或字段等元素上时,会有对应的说明或提示. 不过,常出现下面的问题: Note:An exception occurred while getting the javadoc.see log for details. Note:This

JavaDoc的生成规则---ShinePans

用法: javadoc [options] [packagenames] [sourcefiles] [@files] -overview <file>          从 HTML 文件读取概览文档 -public                   仅显示 public 类和成员 -protected                显示 protected/public 类和成员 (默认值) -package                  显示 package/protected/p

javadoc注释规范

javadoc做注释 一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /** * ......... * ......... */ javadoc -d 文档存放目录 -author -version 源文件名.java 这条命令编译一个名为 “源文件名.java”的 java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 index.html

[笔记&amp;轮子]java源码 生成本地javadoc api文档

在用Eclipse写java代码时候,有时候因为不知道一个java函数的作用,会通过把鼠移动到java函数上,如果它有javadoc的相关内容就会显示出来.但是并非所有java代码都有javadoc:即使安装了javadoc,在eclipse中如果不进行设定,也可能无法使用. 我在win7下安装的是javase的jdk,发现eclipse中默认的javadoc路径是http://download.oracle.com/javase/7/docs/api/,显然这是一个在线资源,问题是网络总是不稳