Java基础：生成JavaDoc文档的方法

Java Doc

javadoc命令是用来生成自己API文档的

参数信息
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

一、用命令行生成JavaDoc
1.在IDEA选择选择要操作的类

2.在上方的导航栏里输出cmd 调出命令行窗口

3，输入代码javadoc -encoding UTF-8 -charset UTF-8 + 文件名

-encoding(编码) UTF-8 -charset（字符集） UTF-8 （防止乱码）

比如：

javadoc -encoding UTF-8 -charset UTF-8 ProvinceServiceImpl.java

或者

javadoc -d 路径 -version -author 类名(-version -author是你需要的信息)

比如：

javadoc -encoding utf-8 -d \\D:\javaweb\day23_redis\代码\day23_redis\src\cn\itcast\servic e -version -author ProvinceService.java

（带上-encoding utf-8 ）

要不然

4.再回去看文件

就会得到一个页面

用命令行生成JavaDoc文档的方法就完成了啦

二、用IDEA生成Doc文档
1.打开IDEA

选择要操作的文件
输出的路径，记得是要在IDEA里创建的包
可以决定文档的语言，中文的就输入zh_CN
传入命令行的参数 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api（双引号内的生成的html页面标签的标题可自己定义）

3.点击确定后在IDEA左下角可以看到下图所示

4.在文件管理器里找到生成的html

生成的页面如下

javadoc 工具软件识别以下标签：

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

Java基础：生成JavaDoc文档的方法相关推荐

java自动生成接口文档
java自动生成接口文档 maven依赖工具类展示效果首页接口页在平时的开发过程中必定要写接口文档作为程序员最烦的2件事 1.别人让你写接口文档 2.接手别人的项目没有接口文档由此可见 ...
如何使用idea生成javaDoc文档
如何使用idea生成javaDoc文档代码写好注释文件生成注释生成参数运行效果控制台 "C:\Program Files\Java\jdk1.7.0_17\bin\javadoc. ...
java快速生成数据库文档
前言在产品发布前夕,经常因为编写各类设计文档感到心碎,倒不是难,而是比较繁琐,举例来说,像编写数据库文档这种操作来说,对于新手,甚至很多有一定开发经验的同学来说,都觉得是一件费力得事情,下面推荐一个 ...
php 2003生成word,使用PHPWord生成word文档的方法详解
使用PHPWord生成word文档的方法详解来源:中文源码网浏览: 次日期:2019年11月5日 [下载文档: 使用PHPWord生成word文档的方法详解.txt ] (友情提示 ...
XDoc 基于Java注释生成API文档
XDoc 基于Java注释生成API文档  <dependency><groupId>com.github.treeleafj< ...
php生成 word,使用PHPWord生成word文档的方法详解
本文实例讲述了使用PHPWord生成word文档的方法.分享给大家供大家参考,具体如下: 有时我们需要把网页内容保存为Word文档格式,以供其他人员查看和编辑.PHPWord是一个用纯PHP编写的库, ...
关于用java编写生成word文档，动态添加数据到word文档的一些心得
关于用java编写生成word文档,动态添加数据到word文档的一些心得,经过翻阅了无数的有用的和无用的资料以后,总算找到了一种靠谱的方法 1.概述经过反反复复的查阅资料,总算找到了一个靠谱的生成w ...
python 生成html文档,Python使用pyh生成HTML文档的方法示例
Python使用pyh生成HTML文档的方法示例来源:中文源码网浏览: 次日期:2018年9月2日 [下载文档: Python使用pyh生成HTML文档的方法示例.txt ] (友 ...
php导出doc文件_PHP生成Word文档的方法
PHP生成Word文档的方法首先,请确保在你的Windows系统中已经安装并配置好了一个典型的WAMP环境.由于Interop纯粹是一个Windows的特性,我们将在Windows平台下搭建Apac ...

Java基础：生成JavaDoc文档的方法

Java基础：生成JavaDoc文档的方法相关推荐

最新文章

热门文章