【问题标题】:Doxygen, how to describe a Java packageDoxygen,如何描述一个Java包
【发布时间】:2012-10-18 05:17:44
【问题描述】:

我不太确定我应该如何使用 Doxygen 记录 Java 包。在 C++ 中,您可以简单地描述一个名称空间,因为它已被声明,但 Java 包从未真正明确地声明过。我尝试在包 mypackage.subpackage 之前添加描述;声明但无济于事。我发现这种工作是如果我要制作一个新文件并简单地做

/**
@namespace mypackage.subpackage
@brief my description
*/

它会出现在 wiki 上,但这很奇怪,因为一些包被正确描述,而其余包被重复(没有描述要描述的包,而是另一个空且具有相同名称的包是创建)

有人知道在 Doxygen 中描述 Java 包的正确方法吗?

【问题讨论】:

标签: java package doxygen


【解决方案1】:

来自stackoverflow.com/questions/7368584/doxygen-and-package-html 的复制粘贴以便于参考:

为 Java 包提供文档的新替代方法是使用名为 package-info.java 的文件而不是 package.html。 (故意选择的文件名不是有效的类名。)

它有不同的语法:

/**
 * any javadoc comments (including tags)
 */
package name;

【讨论】:

    【解决方案2】:

    如果您使用的是 Java 1.4 或更低版本,则必须有一个 package.html,这是一个完整的 html 文件。

    1.4以后可以使用package-info.java文件,格式为

    /**
     * com.foo is a group of bar utils for operating on foo things.
     */
    package com.foo;
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2016-09-14
      • 2020-07-25
      • 2017-01-02
      相关资源
      最近更新 更多