MyEclipse Javadoc文档生成:/**注释规范与API文档导出教程

星夢妙者

星夢妙者

2026-06-29

380人浏览

原创

myeclipse 依赖项目关联的 jdk 和源码配置生成 javadoc,常见问题源于 jdk 路径错误、源码未附加、source folder 设置不当、编码与 locale 不一致、注释格式不规范或 jdk 版本兼容性问题。

myeclipse javadoc文档生成:/**注释规范与api文档导出教程

MyEclipse 本身不提供独立的 Javadoc 生成入口,它只是把 Eclipse 的 Javadoc 导出功能包装了一下——真正起作用的是 javadoc 命令和项目 JDK 配置。如果你点“Export Javadoc”没反应、报错或输出空白,大概率是 JDK 路径、源码范围或编码设置没对上。

确认 JDK 和源码路径是否被 MyEclipse 正确识别

MyEclipse 依赖项目关联的 JDK 提供 javadoc.exe(Windows)或 javadoc(macOS/Linux),同时必须能定位到 Java 源文件(.java),而非仅编译后的 .class 文件。

  • 右键项目 → PropertiesJava Build PathLibraries 标签页,展开你用的 JRE/JDK,确认 Source attachment 是否指向实际源码目录(如 src.zip 或解压后的 src 文件夹);若显示 “Not attached”,点击 Edit 补上
  • 检查项目是否启用了 Source folders:在 Build PathSource 标签页里,确保含 .java 的目录(如 src/main/java)已列为 source folder,且未被排除(Excluded pattern 为空或合理)
  • 如果项目用了 Maven,确认 pom.xml 中没有禁用源码绑定,例如 <generatesources>false</generatesources> 这类配置要删掉

javadoc 命令行参数与 MyEclipse GUI 对应关系

MyEclipse 的导出向导本质是组装 javadoc 命令。很多失败源于 GUI 里选了“Private”但没勾“Include all members”,或编码选了 UTF-8 却没传 -encoding UTF-8 -docencoding UTF-8 -charset UTF-8

  • “Visibility” 选项直接影响 -public/-protected/-package/-private 参数:选 Private 时,MyEclipse 会加 -private,但若类/方法没写 @param@return,Javadoc 仍可能跳过它们——不是 bug,是 javadoc 工具本身行为
  • “Output folder” 必须是空目录,否则 MyEclipse 会静默失败(不报错但无文件生成);建议每次导出前手动清空目标路径
  • “Locale” 和 “Encoding” 必须一致:比如选 zh_CN + UTF-8,对应命令中需同时有 -locale zh_CN -encoding UTF-8 -docencoding UTF-8 -charset UTF-8,缺一不可,否则中文注释变乱码

常见 /** */ 注释失效场景

Javadoc 解析器只认紧贴类、接口、字段、方法声明上方的 /** */ 块注释。格式不对、位置偏移、嵌套错误都会导致内容丢失。

Java JDK 25
Java JDK 25

Java JDK 25 来自 OpenJDK 官方归档,版本为 JDK 25,本条下载地址已指向官方 Windows x64 zip 安装包直链,适合调试旧项目或兼容旧版 Java 运行环境。

下载
  • 方法内写的 /** */ 不会被提取——哪怕它写得再详细,javadoc 工具直接忽略
  • /* */(双星号但非三斜杠)或 // 注释不会进入 API 文档
  • 类注释后如果紧跟 @author 但没换行,比如 /** @author Tom*/,部分 JDK 版本会解析失败;规范写法是 /** <p>描述…</p> <p>@author Tom</p> */
  • 使用 @see 时,引用其他类要带完整包名(如 @see java.util.List),否则链接无效;引用本类成员可用 @see #methodName()

最常被忽略的是 JDK 版本兼容性:JDK 11+ 默认禁用 javax.* 和部分 HTML 标签(如 <font></font>),如果注释里写了 <font color="red"></font>,导出时会警告并跳过该段——得改用 CSS 或删掉。另外,MyEclipse 内置的 Eclipse 版本较老,遇到高版本 JDK 的新特性(如 @snippet)可能直接报 unsupported tag 错误。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

java eclipse myeclipse

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

相关专题

更多
java
java

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

2023.06.15

3863

6

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

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

2023.07.05

2838

9

java自学难吗
java自学难吗

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

2023.07.31

2875

8

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

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

2023.08.01

637

3

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

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

2023.08.02

602

3

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

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

2023.08.02

706

5

java有什么用
java有什么用

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

2023.08.02

1316

5

java在线网站
java在线网站

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

2023.08.03

18845

3

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

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

2023.08.03

647

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

PHP开发编码规范
PHP开发编码规范

共37课时 | 69.8万人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习