Question

到目前为止，我知道如何为函数和类编写JavaDocs，但有没有办法在项目级编写JavaDocs？我主要想的是有关谁为项目做出贡献的信息，来源，参考资料等。

Answer 1

项目层面没有多少。我在这里看到两个选项：

使用javadoc中可能（且可取）的“包级别”（自Java 1.5起可能）。这使用一个名为'package-info.java'的特定java文件，它放在包中的其他类中。典型的内容是：

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

使用您的依赖项文件（如果您使用的话），例如Maven pom.xml。这通常是“专业级别”，并为贡献者提供了一些特定选项（因为它在开源世界中使用得很多）。这是一个exerpt，请查看https://maven.apache.org/pom.html#More_Project_Information了解更多详情：

  <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。 in这个类只是包声明和javaDoc注释。 Link

在哪里编写项目级JavaDocs

2 个答案: