在哪里编写项目级JavaDocs

Question

到目前为止，我知道如何为函数和类编写JavaDocs，但是有任何方法可以在项目级别上编写JavaDocs吗？我主要考虑的是谁为这个项目做出贡献的信息、来源、参考资料等等。

Answer 1

在项目级别上没有太多。我在这里看到两种选择：

在javadoc中使用“包级”，这是可能的(也是可取的)(自Java1.5以来可能)。这使用了一个名为‘Packy-info.java’的特定java文件，您可以在包中放置其他类。典型的内容是：

/**
 * com.destroyearth.raygun regroup all classes related to make the Raygun works.
 */
package com.destroyearth.raygun;

使用依赖文件(如果使用的话)，比如Maven pom.xml。这通常是"projet级别“，并为贡献者提供了一些特定的选项(因为它在开源世界中经常使用)。下面是一个很大的努力，查看信息以获得更多细节：

  <developers>
    <developer>
      <id>eric</id>
      <name>Eric</name>
      <email>eredmond@codehaus.org</email>
      <url>http://eric.propellors.net</url>
      <organization>Codehaus</organization>
      <organizationUrl>http://mojo.codehaus.org</organizationUrl>
      <roles>
        <role>architect</role>
        <role>developer</role>
      </roles>
      <timezone>-6</timezone>
      <properties>
        <picUrl>http://tinyurl.com/prv4t</picUrl>
      </properties>
    </developer>
  </developers>

(如果您没有使用任何东西来管理您的依赖项，请立即开始)。

Answer 2

您可以在项目的顶层包中创建一个类package-info.java。在这个类中，只有包声明和javaDoc注释。链接