Opensource JavaDoc编辑器

时间:2015-10-12 16:26:06

标签: open-source javadoc

我花了很多时间寻找一个Opensource JavaDoc编辑器或一种轻松编辑JavaDocs或创建package-info文件并返回空白的方法。

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

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

例如:

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

我无法找到能够完成我想要的编辑器,而且我不认为每次更新都会手动编辑文件。

如果没有开源java编辑器可以做到这一点有什么建议吗?

正如我所提到的,我已经尝试过创建package-info文件,但据我所知,只能在该包中添加描述。是否有任何教程或有没有人知道我可以让它显示所选包中的包列表?

提前致谢。

1 个答案:

答案 0 :(得分:0)

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

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

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

  

Javadoc Doclets   您可以使用doclet自定义Javadoc工具输出的内容和格式。 Javadoc工具有一个默认的“内置”doclet,称为标准doclet,可生成HTML格式的API文档。您可以修改或子类化标准doclet,也可以编写自己的doclet来生成HTML,XML,MIF,RTF或您想要的任何输出格式。有关doclet及其使用的信息位于以下位置:

     

Javadoc Doclets

您将使用自己的Standard Doclet实现,找到要覆盖的正确类 - 首先尝试查看PackageDoc类。我现在正在经历这个学习过程,但这里是the info on Doclet,页面底部有一个链接到源代码,它将说明如何做到这一点。

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