久久久久久久999_99精品久久精品一区二区爱城_成人欧美一区二区三区在线播放_国产精品日本一区二区不卡视频_国产午夜视频_欧美精品在线观看免费

 找回密碼
 立即注冊

QQ登錄

只需一步,快速開始

搜索
查看: 2463|回復: 0
收起左側

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

[復制鏈接]
ID:365754 發表于 2020-5-18 21:40 | 顯示全部樓層 |閱讀模式
你的代碼可以規范到什么程度?為什么stm32官方歷程那樣編寫注釋
那么首先我們來看一個軟件幫助文檔:由于篇幅我們截取幾張簡單的圖片
2020-05-18_212920.png
2020-05-18_212934.png
2020-05-18_212945.png

是的,嵌入式單片機也可以這樣寫注釋,文件引用關系、文件成員列表、成員函數和成員變量、類繼承關系圖等等等等都可以顯示出來
其實這個例子就是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, 下載次數: 9, 下載積分: 黑幣 -5

回復

使用道具 舉報

您需要登錄后才可以回帖 登錄 | 立即注冊

本版積分規則

手機版|小黑屋|51黑電子論壇 |51黑電子論壇6群 QQ 管理員QQ:125739409;技術交流QQ群281945664

Powered by 單片機教程網

快速回復 返回頂部 返回列表
主站蜘蛛池模板: 毛片免费视频 | 日本理论片好看理论片 | 日本一区视频在线观看 | 国内精品一区二区三区 | 日韩一区二区三区视频 | 最新国产精品 | 欧美一级视频在线观看 | 欧美综合在线观看 | 亚洲一区二区三区在线 | 九九热精品视频 | 99久久精品免费看国产高清 | 国产伦精品一区二区三区四区视频 | 欧美亚洲另类丝袜综合网动图 | 特级丰满少妇一级aaaa爱毛片 | 国产精品美女在线观看 | 成人在线欧美 | av影片在线 | 国产一区二区三区欧美 | 国产美女在线播放 | 在线国产小视频 | 最新一级毛片 | 五月婷婷丁香 | 国产精品毛片一区二区在线看 | 免费欧美 | 欧美日韩在线一区二区三区 | 国产一区二区不卡 | 欧美日韩1区2区3区 欧美久久一区 | 另类 综合 日韩 欧美 亚洲 | 欧洲视频一区二区 | 麻豆精品国产免费 | 欧美一区不卡 | 成人免费视频 | 91av小视频| 中文字幕一区二区三区不卡 | 亚洲网址 | 欧美中文字幕一区二区 | 亚洲一区二区三区四区五区中文 | 美女视频网站久久 | 9久9久 | 精品欧美一区二区三区久久久 | 欧美视频网 |