1. 首頁
  2. 問答
  3. Doxygen and package.html

Doxygen and package.html

2011-09-09 64 views
2

根據javadoc規範，我在相關包的根目錄下放置了一個名爲package-info.html的文檔文件。但是，當我在該文件夾上運行Doxygen時，該文件中的文檔未被拾取。我如何告訴Doxygen使用這個文件作爲包文檔？我也試過package.html，舊的規範，但這是行不通的，要麼Doxygen and package.html

來源

2011-09-09 Nate Glenn

+1

實際上，目前的做法是使用'package-info.java'而不是'package.html'。 （雖然不知道Doxygen。） –

+0

好吧，我改變了它，doxygen仍然沒有做到這一點。我將編輯我的帖子。 –

+0

只是爲了確保：它是'package-info.java'，而不是'.html'，[它具有不同的語法]（http://download.oracle.com/javase/6/docs/technotes/tools /solaris/javadoc.html#packagecomment）。 –

回答

3

爲Java包提供文檔的新替代方法是使用名爲package-info.java而不是package.html的文件。 （該文件名被有意地選擇不是有效的類名。）

它有一個不同的語法：

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

這也是提供註解包（其package之前注意到的唯一方式關鍵字在這裏，如果有的話）。

從您的意見到問題，它看起來像最新版本的Doxygen只明白這package-info.java，而不是舊的package.html文件。

我記得有一個模塊系統提出，然後會添加一個類似的module-info.java文件，但我現在沒有找到它後，短暫的谷歌。 （也許JSR 294？）

來源

2011-09-10 22:01:49

相關問題

 相關問題