你的代碼可以規范到什么程度？Doxygen軟件應用

你的代碼可以規范到什么程度？為什么stm32官方歷程那樣編寫注釋
那么首先我們來看一個軟件幫助文檔：由于篇幅我們截取幾張簡單的圖片




是的，嵌入式單片機也可以這樣寫注釋，文件引用關系、文件成員列表、成員函數和成員變量、類繼承關系圖等等等等都可以顯示出來
其實這個例子就是STM32官方庫函數，他就是這樣做的，代碼注釋符合Doxygen規范，所以可以產生簡單易懂的幫助文件。我們可以隨便找一個可文件查看效果相同。

Doxygen

Doxygen是一種開源跨平臺的，以類似JavaDoc風格描述的文檔系統，完全支持C、C++、Java、Objective-C和IDL語言，部分支持PHP、C#。注釋的語法與Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以從一套歸檔源文件開始，生成HTML格式的在線類瀏覽器，或離線的LATEX、RTF參考手冊。

Doxygen能將程序中的特定批注轉換成為說明文件。它可以依據程序本身的結構，將程序中按規范注釋的批注經過處理生成一個純粹的參考手冊，通過提取代碼結構或借助自動生成的包含依賴圖（include dependency graphs）、繼承圖（inheritancediagram）以及協作圖（collaboration diagram）來可視化文檔之間的關系，Doxygen生成的幫助文檔的格式可以是CHM、RTF、PostScript、PDF、HTML等。

HTML Help WorkShop

微軟出品的HTML Help WorkShop是制作CHM文件的最佳工具，它能將HTML文件編譯生成CHM文檔。

Doxygen軟件默認生成HTML文件或Latex文件，我們要通過HTML生成CHM文檔，需要先安裝HTML Help WorkShop軟件，并在Doxygen中進行關聯。 軟件的下載鏈接，使用方法請參考附件。

Doxygen代碼注釋規范.docx (1.5 MB, 售價: 1 E幣)

2020-5-20 02:01 上傳

點擊文件名下載附件
售價: 1 E幣  [記錄]  [購買]

【必讀】版權免責聲明

1、本主題所有言論和內容純屬會員個人意見，與本論壇立場無關。2、本站對所發內容真實性、客觀性、可用性不做任何保證也不負任何責任，網友之間僅出于學習目的進行交流。3、對提供的數字內容不擁有任何權利，其版權歸原著者擁有。請勿將該數字內容進行商業交易、轉載等行為，該內容只為學習所提供，使用后發生的一切問題與本站無關。 4、本網站不保證本站提供的下載資源的準確性、安全性和完整性;同時本網站也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的損失或傷害。 5、本網站所有軟件和資料均為網友推薦收集整理而來，僅供學習用途使用，請務必下載后兩小時內刪除，禁止商用。6、如有侵犯你版權的，請及時聯系我們（電子郵箱1370723259@qq.com）指出，本站將立即改正。