如何按外观顺序创建Java文档?
我有一个非常大的.java类文件,它有很多成员。我如何为此创建HTML文档,以便它按外观顺序显示成员,而不按成员类型排序?(方法、常数和变量) 例如,如果我的Java代码是:如何按外观顺序创建Java文档?,java,javadoc,documentation-generation,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 d
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()
此外,是否有使用更智能功能生成的文档?比如:
Javadoc的标准doclet不支持方法的自定义显示顺序。如果您需要这个特性,您将需要开发一个定制的doclet(或者找到一个满足您需求的现有doclet)
除了Javadoc之外,还有许多文档生成器可以处理java。有两个这样的工具。我相信这两种工具都提供了选项,使项目(例如方法)在生成的文档中的显示顺序与在源代码中的显示顺序相同。另一种可能的方法是简单地将属于一个或多个单独类的成员分离出来,如果它们在概念上与类中的其他成员分离……/p>我可以使用任何其他能够读取java类文件的文档生成器。我添加了一些关于JavaDoc以外的工具的信息,您可能会考虑使用。该类工作得很好,它不是您的每一个约翰程序。它太复杂了,我宁愿理解它,也不想重新设计它。当然,明白了。我忍不住要指出,您描述的这种情况正是重构能够提供帮助的情况。不幸的是,关于文档,我没有一个有用的答案:-|