你的代碼可以規(guī)范到什么程度?為什么stm32官方歷程那樣編寫注釋
那么首先我們來看一個(gè)軟件幫助文檔:由于篇幅我們截取幾張簡(jiǎn)單的圖片
2020-05-18_212920.png (153.73 KB, 下載次數(shù): 62)
下載附件
2020-5-18 21:35 上傳
2020-05-18_212934.png (165.44 KB, 下載次數(shù): 77)
下載附件
2020-5-18 21:36 上傳
2020-05-18_212945.png (166.63 KB, 下載次數(shù): 66)
下載附件
2020-5-18 21:36 上傳
是的,嵌入式單片機(jī)也可以這樣寫注釋,文件引用關(guān)系、文件成員列表、成員函數(shù)和成員變量、類繼承關(guān)系圖等等等等都可以顯示出來
其實(shí)這個(gè)例子就是STM32官方庫(kù)函數(shù),他就是這樣做的,代碼注釋符合Doxygen規(guī)范,所以可以產(chǎn)生簡(jiǎn)單易懂的幫助文件。我們可以隨便找一個(gè)可文件查看效果相同。
DoxygenDoxygen是一種開源跨平臺(tái)的,以類似JavaDoc風(fēng)格描述的文檔系統(tǒng),完全支持C、C++、Java、Objective-C和IDL語(yǔ)言,部分支持PHP、C#。注釋的語(yǔ)法與Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以從一套歸檔源文件開始,生成HTML格式的在線類瀏覽器,或離線的LATEX、RTF參考手冊(cè)。 Doxygen能將程序中的特定批注轉(zhuǎn)換成為說明文件。它可以依據(jù)程序本身的結(jié)構(gòu),將程序中按規(guī)范注釋的批注經(jīng)過處理生成一個(gè)純粹的參考手冊(cè),通過提取代碼結(jié)構(gòu)或借助自動(dòng)生成的包含依賴圖(include dependency graphs)、繼承圖(inheritancediagram)以及協(xié)作圖(collaboration diagram)來可視化文檔之間的關(guān)系,Doxygen生成的幫助文檔的格式可以是CHM、RTF、PostScript、PDF、HTML等。
HTML Help WorkShop
微軟出品的HTML Help WorkShop是制作CHM文件的最佳工具,它能將HTML文件編譯生成CHM文檔。 Doxygen軟件默認(rèn)生成HTML文件或Latex文件,我們要通過HTML生成CHM文檔,需要先安裝HTML Help WorkShop軟件,并在Doxygen中進(jìn)行關(guān)聯(lián)。 軟件的下載鏈接,使用方法請(qǐng)參考附件。
|