Doxygen
外觀
Doxygen是一个適用 C + +、C、Java、Objective-C、Python、IDL(CORBA 和 Microsoft flavors)、 Fortran、VHDL、PHP、C # 和 D 語言的文件生成器。伊會當佇大部份的數類 Unix 操作系統、macOS 以及 Microsoft Windows 上執行。初型版本的 Doxygen 使用一寡舊版本 DOC + + 的原始碼,佇遐了後,Dimitri van Heesch 重寫矣 Doxygen 的原始碼。
Doxygen 是一个編寫軟體參考文件的工具。該文件是直接寫佇原始碼中的,因此較好保持閣較新。Doxygen 會當交叉參照佮原始碼,檔案的讀者會當誠容易來參考實際的原始碼。
KDE 將 Doxygen 做伊的一部份而且 KDevelop 有內起的支援。 Doxygen 的釋出遵守 GNU 通用公眾授權條款,是自由軟體。
用法
如同 Javadoc,Doxygen 對原始檔提註解。除了 Javadoc 的語法,Doxygen 支援 Qt 使用的文件標記,並會使輸出成 HTML、以及 CHM、RTF、PDF、LaTeX、PostScript 抑是手冊頁。
範例代碼
注釋文件一般用兩个星號標誌:
但是嘛會當像 HeaderDoc 仝款使用\ * !的標誌。比如講:
以下說明按怎對 C + + 原始碼產生文件。請確保參數 EXTRACT \ _ ALL 佇咧 Doxyfile 設定做 YES。
另外一種方法是首選的一寡參數的記錄如下。這將產生仝款的檔案。
外部連結
- 官方網站
- SourceForge . net 上的 Doxygen
- Freecode 上的 Doxygen
- MediaWiki documentation in Doxygen
- Example of documentation automatically generated by Doxygen for Apache Harmony