利用javadoc制作API文档

要制作API文档，首先要保证代码中的文档注释无误，文档注释以【 /** 】开始，【 */ 】结尾，示例如下：

package jtest;
/**
* Description:
* <br/>网站: <a href="http://blog.csdn.net/ibooks">Monkey王！的博客</a>
* <br/>Copyright (C), 2012, Monkey王！
* <br/>This is Monkey王's blog!Welcome!.
* @author Monkey王！
* @version 1.0
*/
public class Monkey{
/**
*返回打招呼字符串的方法
*@param name 该参数指定向谁打招呼
*@return 返回打招呼的字符串
*/
public String hello(String name){
return name+"，你好！";
}
}
（PS:以上注释中@author、@version、@param、@return是常用的javadoc标记。）

javadoc命令格式如下：javadoc [选项] [Java源文件/包名]。

1.常用选项有：-d、-windowtitle、-doctitle、-header、-version、-author等。

2.示例：现有JavaMonkey.java、Monkey.java两个源文件，分别存放在jtest、test两个包里。

windows键+R-->cmd-->进入包或者源文件所在位置-->输入以下命令：

javadoc -d 要保存api文档的路径 -windowtitle api文档的浏览器标题 -doctitle api文档的概述页面的标题 -header 页面的页眉 -version -author jtest test （每个参数和设定的值之间用空格分割开来。）

注意：

1 确保保存api文档的目录存在，源文件所在文件夹名要与包名相同，否则找不到文件。

2 上述命令末尾可以使用源文件名也可以使用包名。例如，源文件名时可以写成 *Monkey.java，支持通配符。

3 -windowtitle、-doctitle后头的字符串如果包含空格，需用" "双引号包含起来，否则系统会当做多个参数执行，最后报错。

示例：javadoc -d apidoc -windowtitle "this is windowtitle" -doctitle "this is doctitle" -header myclass -version -author jtest test

4 @author、@version信息javadoc默认是不会提取的，必须在javadoc命令中指定 -version、-author。

5 如果需要加入程序包的详细描述，需要在存放源文件的文件夹里建立相关包描述的html文件，该文件名通常为package.html。

利用javadoc制作API文档相关推荐

在MyEclipse中使用javadoc导出API文档详解
本篇文档介绍如何在MyEclipse中导出javadoc(API)帮助文档,并且使用htmlhelp.exe和jd2chm.exe生成chm文档. 具体步骤如下: 打开MyEclipse,选中想要制作 ...
Javadoc （Java API 文档生成器）详解 [Javadoc 概述][Javadoc 标签][Javadoc 命令][Javadoc 生成 API 文档]
您的"关注"和"点赞",是认可,是支持,是动力. 如意见相佐,可留言. 本人必将竭尽全力试图做到准确和全面,终其一生进行修改补充更新. 文章目录 1 Javad ...
Java文档注释（利用javadoc生成HTML文档）
目录: 1. 在代码中使用文档注释 2. 类注释 3. 方法注释 4. 域注释 5. 通用注释 6. 包与概述注释 7. 注释的抽取 1. 在代码中使用文档注释 Java 程序员在开发的过程中,或多或 ...
Eclipse 如何生成项目的javadoc（API 文档）
文章目录生成 javadoc 的三种方法乱码问题生成 javadoc 的三种方法 1.在项目列表中按右键,选择 Export,然后在 Export 对话框中选择 Java 下的 Javadoc, ...
javadoc - Java API 文档生成器（Windows版本）
文章目录简介命令语法结构 Javadoc Doclets 术语带文档的类引用类外部引用类源文件源代码文件包注释文件概述注释文件其他未处理文件生成的文件基本内容页交叉参考页支 ...
IntelliJ IDEA forMac 如何生成项目的javadoc（API文档）
1.在菜单栏,点击 Tools -> Generate JavaDoc- 2.根据你自己的需要,设置解析源文件的范围.设置文档输出目录.设置资源的访问权限范围.字符编码.堆内存大小等.
.NET Core 3.0 使用Nswag生成Api文档和客户端代码
摘要在前后端分离.Restful API盛行的年代,完美的接口文档,成了交流的纽带.在项目中引入Swagger (也称为OpenAPI),是种不错的选择,它可以让接口数据可视化.下文将会演示利用N ...
大牛推荐丨积分活动工具接口：积分商城api文档
什么是积分?自积分概念提出以来,积分活动已经成为一种非常流行的运营工具.对于积分,现在已经有一个比较完善和成熟的积分商城体系,在企业运营者的眼里,积分活动自然成为一种良好的积分商城运营模式. 利用积分 ...
利用Javadoc工具生成api文档
2019独角兽企业重金招聘Python工程师标准>>> step1:将写好的程序源码存入某路径下 step2:cmd进入该路径 step3:执行命令生成api文档命令:javad ...

利用javadoc制作API文档

利用javadoc制作API文档相关推荐

最新文章

热门文章