wordpress category order北京网站优化托管

生成 JavaDoc 文档

1、快速生成 文档 注解
2、常见的文档注解
3、脚本生成 doc 文档
4、IDEA工具栏生成 doc 文档

第一章 快速入门

第01节 使用插件

在插件工具当中，找到插件 javaDoc

使用方式，在代码区域，直接点击右键。选择

第02节 常用注解

作用在 类或者接口 上面

注解名称	使用案例	详细说明
author	@author cosmo	作者 cosmo
version	@version 1.0	版本 1.0
apiNote	@apiNote	API 介绍

作用在方法上

注解名称	使用案例	详细说明
author	@author cosmo	作者 cosmo
version	@version 1.0	版本 1.0
return	@return	返回值介绍
param	@param	参数介绍
throws	@throws	异常说明

其他注解

注解名称	使用案例	详细说明
see	@see	引用其他类、接口、方法、文档
since	@since	说明该 类、方法、或者字段 从哪个版本开始引入
link	@link	连接某个地址或者类 接口 方法
deprecated	@deprecated	标记已经过时的方法或者类
code	@code	某个代码片段

第03节 生成文档的效果

第二章 快速脚本

第01节 脚本代码

@echo off   
setlocal enabledelayedexpansion:: 只需要修改当前项目所在的目录、匹配上 src 路径和包名称的根路径
set "ROOT_PATH=D:\workspace\demo04\XCPP"
set "srcPath=%ROOT_PATH%\src"
set "packageName=com"
:: -------------------------------------------------------------
set "docPath=.\docs" 
:: =============================================================:: 检查Java环境是否已配置   
where java >nul 2>&1   
if %errorlevel% neq 0 (echo error：not found Java Environment，please install and configure Java first。pauseexit /b 1   
):: 检查Javadoc是否可用   
where javadoc >nul 2>&1   
if %errorlevel% neq 0 (echo Error: Javadoc tool not found, please ensure JDK is installedpauseexit /b 1   
):: 删除之前旧的 docs 文件夹  
if exist "%docPath%" (  echo delete old docs rmdir /s /q "%docPath%"       
):: 执行 Javadoc 命令   
echo Generating Javadoc....
javadoc -encoding UTF-8 -charset UTF-8 -d  %docPath% -sourcepath %srcPath% -subpackages %packageName%if %errorlevel% equ 0 (echo -------------------------------------------------------------echo Javadoc Successfully generated, document located at: %docPath%echo -------------------------------------------------------------
) else (echo Javadoc Generation failed, please check the command or path.
)pause   
endlocal

第02节 后续说明

在脚本代码当中，需要修改以下几点：

修改项	说明	是否必填
ROOT_PATH	项目的绝对路径	是（建议根据实际情况修改）
srcPath	src 文件夹的路径	是（根据项目不同 src 的相对项目路径不一致，是需要进行修改的）
packageName	一级包的路径	是（目前默认的一级包路径是 com 后面根据实际需求来确定）
docPath	生成DOC文档的路径	否（目前是生成在当前脚本，所在的目录下面，是否在其他位置，根据实际需求来确定）

第03节 系统工具类

在系统工具栏上面，可以直接生成 doc 文档。