代码之家  ›  专栏  ›  技术社区  ›  Robin Rodricks

如何根据外观创建Java文档?

  •  2
  • Robin Rodricks  · 技术社区  · 16 年前

    我有一个很大的.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 回复  |  直到 6 年前
        1
  •  4
  •   albert    6 年前

    JavaDoc的标准doclet不支持方法的自定义显示顺序。如果您需要这个特性,您需要开发一个定制的doclet(或者找到一个满足您需求的现有doclet)。

    除了JavaDoc之外,还有许多可以处理Java的文档生成器。 doxygen ROBODoc 是两个这样的工具。我相信这两种工具都提供了选项,使项目(例如方法)在生成的文档中显示的顺序与在源代码中显示的顺序相同。

        2
  •  0
  •   Willie Wheeler    16 年前

    另一种可能的方法是简单地将属于一个或多个单独的类的成员分解出来,如果它们确实在概念上与类中的其他成员分离…