Eclipse中如何通过-overview参数将overview.html合并到JavaDoc索引页

-overview 是Javadoc工具的自有参数，你之前将参数填写到VM选项栏属于配置位置错误，因此无法生效。正确配置方法如下：

1. 确认overview.html存放路径 #

优先使用Eclipse内置路径变量定位文件，避免相对路径识别异常：

• 若文件放在项目根目录，路径为 ${project_loc}/overview.html
• 若文件放在src目录下，路径为 ${project_loc}/src/overview.html

2. 填写到正确的参数栏 #

打开Eclipse的Javadoc生成向导，按以下步骤操作：

• 第一页选中目标Java项目，点击「Next」
• 第二页配置需要生成文档的包、输出目录等信息，继续点击「Next」进入第三页
• 找到页面下方的 Extra Javadoc options（额外Javadoc选项）输入框，不要填写到上方的VM选项栏
• 在输入框中填写对应参数：

  -overview "${project_loc}/overview.html"
  

  若overview.html存放在src目录，将路径替换为 ${project_loc}/src/overview.html 即可，保留引号可避免路径含空格时识别失败。

3. 生成验证 #

点击「Finish」生成Javadoc，打开输出目录中的index.html即可看到概述内容已展示在索引页顶部。

如果配置后仍不生效，可检查以下两点：

• overview.html无需编写完整的<html>``<head>``<body>顶层标签，直接编写正文内容、排版标签即可，多余的顶层标签会导致内容无法正常渲染
• 也可直接填写overview.html的绝对路径代替变量，确保路径指向正确的文件

内容的提问来源于stack exchange，提问作者Andrew S