如何按外观顺序创建Java文档?

时间:2009-09-06 01:18:16

标签: java javadoc documentation-generation

我有一个非常大的.java类文件,它有很多成员。如何为此创建HTML文档,以便按外观顺序向我显示成员,而不按成员类型排序? (方法,常量和变量)

例如,如果我的Java代码是:

 private int typeOfAction_1;      // notice the order:  1,2,3..
 public void startAction_2(){
 }

 private int jobtype_3;
 private int jobcount_4;
 private void doJob_5(){
 }

 public void haltAction_6(){
 }

Javadoc按字母顺序命令成员按类型排序,因此会员之间的关系丢失:

int jobcount_4;        // notice how the order is lost:  4,3,1..
int jobtype_3;
int typeOfAction_1;

doJob_5()
haltAction_6()
startAction_2()

此外,是否有文档生成更智能的功能?像:

  1. 提取附近的方法评论&变量
  2. 方法的大小 - 代码行

2 个答案:

答案 0 :(得分:4)

Javadoc的标准doclet不支持方法的自定义显示顺序。如果您需要此功能,则需要开发自定义doclet(或找到满足您要求的现有doclet)。

除了Javadoc之外,还有许多文件生成器可以处理java。 doxygenROBODoc是两个这样的工具。我相信这两个工具都为项目(例如方法)提供了选项,使其在生成的文档中以与源代码中出现的顺序相同的顺序出现。

答案 1 :(得分:0)

另一种可能的方法是简单地将属于一起的成员分解为一个或多个单独的类,如果它们在概念上与该类中的其他成员分开......