开源 JavaDoc 编辑器

Opensource JavaDoc editor

我花了几天时间寻找开源 JavaDoc 编辑器或一种轻松编辑 JavaDoc 或创建包信息文件的方法,但结果是空的。

我基本上是在想办法改变包的列出方式。我工作的自动化框架正在经历一些潜在的未来变化。简而言之,这些更改将组织我们的测试脚本,将它们分成业务领域,然后分成该领域内更小的业务功能包。

我们使用 IntelliJ,默认的 JavaDoc 生成器以一种列出所有包的方式创建 JavaDoc,我想要做的是让它创建一个主要包(业务领域)的列表,然后其中的子包包含我们的测试脚本(业务功能)。

例如:

BusinessAreaOne 包含 BusinessFunctionOne、BusinessFunctionTwo 和 BusinessFunctionThree。 BusinessAreaTwo 包含 BusinessFunctionFour 和 BusinessFunctionFive。 BusinessFunction 包又包含仅涵盖该业务功能的脚本。

我一直没能找到一个编辑器来做我想要的,而且我认为每次有更新时手动编辑文件是不切实际的。

如果没有开源 java 编辑器可以做到这一点,有什么解决方法的建议吗?

正如我提到的,我已经尝试创建包信息文件,但据我所知,您只能为该包添加描述。是否有任何教程或有人知道我可以用它来显示所选包中的包列表的方法吗?

提前致谢。

Javadoc 不会将包层次结构视为嵌套层次结构,它只是将它们全部平展到一个列表中,正如您可能注意到的那样,因此您的业务功能将仅作为列表中业务区域之间的条目出现。

寻找 Javadoc 编辑器对您没有帮助,因为您最终得到的 Javadoc 是 Javadoc 编译过程的输出,并且您没有可以在代码中放置会影响编译过程的特定标记您正在寻找的方式。

您必须编写一些内容来覆盖 Javadoc 的 HTML 格式化程序的实现,专门用于包列表,使用:

Javadoc Doclets You can customize the content and format of the Javadoc tool's output by using doclets. The Javadoc tool has a default "built-in" doclet, called the standard doclet, that generates HTML-formatted API documentation. You can modify or subclass the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you'd like. Information about doclets and their use is at the following locations:

Javadoc Doclets

您将使用自己的 Standard Doclet 实现,找到正确的 class 进行覆盖 - 尝试先查看 PackageDoc class。我目前正在自己​​经历这个学习过程,但这里是 the info on Doclet,并且在该页面底部有一个 link 到源代码,它们将说明如何做到这一点。

当然可以有更简单的方法,如果我发现它,我会回来更新这个答案。