2012-10-28 152 views
3

我不太清楚我應該如何使用Doxygen來記錄Java包。在C++中,您可以簡單地描述聲明的名稱空間,但Java包永遠不會被明確聲明。我嘗試在包mypackage.subpackage之前添加說明;宣言,但無濟於事。我發現那種作品的是,如果我是做一個新的文件,並簡單地做Doxygen,如何描述Java包

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

它會出現在維基,但它的奇怪,因爲一些包被正確描述,其餘的都重複(將描述的包沒有描述,而是另一個空的包,並創建了相同的名稱)

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

+2

裝飾你的package-info.java文件與評論。 – chrislhardin

+2

請參閱http://stackoverflow.com/questions/7368584/doxygen-and-package-html – Sonson123

回答

1

如果您使用的是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; 
2

stackoverflow.com/questions/7368584/doxygen-and-package-html一個copypaste,以供參考:

新的替代的方式來提供一個Java包文檔是使用package-info.java文件命名,而不是package.html的的。 (文件名是故意選擇不成爲一個有效的類名。)

它有不同的語法:

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