生成JavaDoc文档

生成 JavaDoc 文档

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

第一章 快速入门

第01节 使用插件

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

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

第02节 常用注解

作用在 类或者接口 上面

作用在方法上

其他注解

第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。
    pause
    exit /b 1   
)
   
:: 检查Javadoc是否可用   
where javadoc >nul 2>&1   
if %errorlevel% neq 0 (
    echo Error: Javadoc tool not found, please ensure JDK is installed
    pause
    exit /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节 后续说明

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

第03节 系统工具类

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