生成 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 文檔。
