EditPlus怎么设置javadoc?EditPlus生成Java文档配置教程

陌磊大大_5954

陌磊大大_5954

2026-06-17

668人浏览

原创

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

editplus怎么设置javadoc?editplus生成java文档配置教程

要在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会静默失败不报错。

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载

编写符合规范的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 大师之旅:从入门到精通的终极指南

相关文章

java速学教程(入门到精通)
java速学教程(入门到精通)

java怎么学习?java怎么入门?java在哪学?java怎么学才快?不用担心,这里为大家提供了java速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

editplus java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9857

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7002

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6172

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1064

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

888

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1296

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2589

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19911

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1155

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
EditPlus联机手册
EditPlus联机手册

共0课时 | 0.2万人学习

dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习