接觸Doxygen后，認識到其強大之處，一口氣將之前的爛代碼重構了一遍，所有的文件頭，函數注釋等等都是手動添加注釋。在keil中可以看到其對JavaDoc風格的注釋有高亮，非常好看。但是keil這個IDE作為編譯器和調試工具，好用的沒話說，作為編輯器卻非常不能與時俱進。自動補全，代碼縮進都超爛 ...

1.Doxygen簡介 Doxygen是一個程序的文檔產生工具，可以將程序中的注釋轉換成說明文檔或者說是API參考手冊，從而減少程序員整理文檔的時間。當然這里程序中的注釋需要遵循一定的規則書寫，才能讓Doxygen識別和轉化。 目前Doxygen可處理的程序語言包含C/C++、Java ...

背景 這一塊的內容更多的是作為了解，但是可以以這樣的規范作為自己的編程注釋習慣，提高自己的軟實力。 Doxygen注釋語法 注釋格式 塊注釋建議統一使用 行注釋建議統一使用 Doxygen常用注釋命令 Doxygen注釋示例 1.項目注釋 項目注釋塊用於對項目進行描述 ...

一、doxygen應用場景： doxygen可以用來管理目前主流的編程語言的注釋而形成文檔系統。（包括C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran等）。doxygen官網地址（http ...

　　　　調試Bug說明 　　　　　　解決的bug說明，@bug　　　　警告說明 (warning)　　　　　　定義一些關於這個函數必須知道的事情，@warning　　　　備注說明 (rem ...

前言 ​ 程序中注釋的規范和統一性的重要性不言而喻，本文就推薦一種在用vscode編寫代碼時自動化生成標准化注釋格式的方法，關於Doxygen規范及其使用可查看博文 代碼注釋規范之Doxygen。 ​ 本方法僅作為Doxygen注釋的輔助作用。 Vs code自動生成Doxygen格式注釋 ...

用doxygen風格注釋代碼生成文檔 目錄 用doxygen風格注釋代碼生成文檔 1. 說明 2. 具體操作 2.1 生成頭部注釋 2.2 安裝doxygen 2.3 工程配置 ...

Chapter 1 - 准備工作 (Windows環境) 1.1 程序包下載 1. Doxygen 　　* 源碼： git clone https://github.com/doxygen/doxygen.git 　　* GUI版本：點擊下載 　　* 便攜壓縮包版本：下載 ...