必须先配置javadoc.exe路径及utf-8编码参数,否则生成失败或中文乱码;需编写规范javadoc注释、保存为utf-8编码;执行后检查api目录及index.html内容完整性。

要在EditPlus中一键生成JavaDoc文档,必须先配置好javadoc.exe命令工具,否则点击菜单时会提示“找不到程序”或直接报错退出。
添加javadoc生成工具
打开EditPlus → 工具 → 配置用户工具 → 点击左侧“用户工具” → 右侧点击“添加工具” → 选择“应用程序”。
在弹出的设置窗口中填写以下内容:
菜单文本:输入“生成JavaDoc”(可自定义,但建议用中文避免编码问题);
命令:定位到JDK安装目录下的bin\javadoc.exe,例如D:\Program Files\Java\jdk-17.0.2\bin\javadoc.exe;
参数:【-d $(FileDir)\api -encoding UTF-8 -charset UTF-8 -windowtitle "$(FileNameNoExt) API" -doctitle "$(FileNameNoExt) 文档" $(FileName)】;
初始目录:$(FileDir);
动作:勾选“捕获输出”。
这一步最关键的是参数写法——必须包含-encoding UTF-8 -charset UTF-8,否则中文注释会显示为乱码“□□□”,且-d后路径不能带空格或中文,否则javadoc会静默失败不报错。
编写符合规范的Java源文件
新建一个.java文件,顶部必须使用标准JavaDoc注释格式:以/**开头、*/结尾,中间每行以*起始。
类上方要写@author和@version,方法上方必须有@param和@return(如果返回非void),否则生成的HTML里这些字段会缺失或为空。
保存文件时,确保文件编码为UTF-8(EditPlus右下角状态栏应显示“UTF-8”,不是ANSI或GBK);若显示GBK,需点击“文档”→“更改编码”→选“UTF-8”→再保存,否则javadoc读取时会卡在第一个中文字符报“不可映射字符”错误。
执行生成并验证结果
第一步:用鼠标单击编辑区任意位置,确保当前焦点在.java文件内;
第二步:点击工具 → 生成JavaDoc;
第三步:观察底部输出窗口——若出现“正在构建所有程序包和类…”且末尾有“已生成 X 个文档”,说明成功;
第四步:前往源文件所在目录,确认生成了名为api的子文件夹;
第五步:双击api\index.html,用浏览器打开,检查类名、作者、版本、方法参数是否完整显示。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南











