Doxygen從零學起———安裝和配置

Doxygen可以為多種語言生成說明文檔(從程序的源代碼中提取其中按照約定格式寫的注釋中提取信息)
例如C++, Objective-C, C#, C, PHP, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, D ,從這期開始,我將系統地介紹Doxygen的使用,包括以下內容:

  1. Doxygen安裝和配置
  2. DOxygen for C++使用說明——注釋代碼一
  3. DOxygen for C++使用說明——注釋代碼二
  4. DOxygen for C++使用說明——添加數學公式
  5. DOxygen for C++使用說明——Markdown支持

安裝

doxygen安裝

我們可以從doxygen官網上下載最新的doxygen軟件,我的是doxygen-1.8.10,然后一路next下去即可。

Graphviz 安裝

Graphviz是大名鼎鼎的貝爾實驗室的幾位牛人開發的一個畫圖工具。
它的理念和一般的“所見即所得”的畫圖工具不一樣,是“所想即所得”。
Graphviz提供了dot語言來編寫繪圖腳本。在doxygen中我們可以使用Graphviz繪制函數調用圖、類的繼承關系圖等各種各樣的圖。
首先先在Graphviz 主頁下載,如下圖:

選擇圖中圈起的版本,然后一路安裝,
注意:一定要記住Graphviz的安裝目錄,以后還會用得著。

HHC.exe安裝

使用Doxygen可以生成多種形式的文件,這里我們選擇生成compressed html(即CHM格式文檔)與latex格式的(即PDF格式文檔),
生成chm文件,需要用到MS HTML Help Compiler,為此我們在HTML Help (CHM) Help Compiler官網下載hhc.exe,然后一路安裝即可。
注意:一定也要記住hhc.exe的安裝目錄,以后還會用得著。

配置

首先先給個福利,此鏈接是我已經配置好的,可以直接使用。
使用方法是:選擇【開始】菜單,打開Doxygen文件夾,選擇Doxywizard程序,然后就出現了以下界面,點擊【File】,選擇【open】,然后:



下面介紹具體的配置方法:
1
2
3
4
5
6
7
8
9
10
11
然后
并且我們可以點擊【File】的【Save】保存配置,下一次就可以直接使用了。

參考文獻

  • DoxyGEN 的使用與Graphviz 的使用
  • 用Doxygen Graphviz生成函數調用流程圖
  • 強大的Doxygen工具使用手冊
  • Doxygen + Graphviz windows下安裝配置(圖解)

本文來自互聯網用戶投稿,該文觀點僅代表作者本人,不代表本站立場。本站僅提供信息存儲空間服務,不擁有所有權,不承擔相關法律責任。
如若轉載,請注明出處:http://www.pswp.cn/news/259099.shtml
繁體地址,請注明出處:http://hk.pswp.cn/news/259099.shtml
英文地址,請注明出處:http://en.pswp.cn/news/259099.shtml

如若內容造成侵權/違法違規/事實不符,請聯系多彩編程網進行投訴反饋email:809451989@qq.com,一經查實,立即刪除!

相關文章

JAVA Drp項目實戰—— Unable to compile class for JSP 一波三折

交代下背景。電腦系統是64位的,用的是64位的Tomcat。安裝是32位的Myeclipse10,java環境也是32位的。Tomcat在開始啟動時會報這樣一個錯誤,“Cant load IA 64-bit .dll on a AMD32-bit platform”。可是不耽誤使用,近期在敲Drp項目…

Java中的ClassLoader

Java中類的加載過程(如Dog類): 通過類型信息定位Dog.class文件。載入Dog.class文件,創建相應的Class對象。執行父類的靜態字段定義時初始化語句和父類的靜態初始化塊。執行子類的靜態字段定義時初始化語句和子類的靜態初始化塊。當…

excel刪除無盡空白行_excel如何批量刪除空白行 巧用 ctrl+G 只需1秒 最常用的技巧...

工作中我們使用excel通常都會遇到這種情況,就是表格中有很多多余的空行。我們需要把多余的空行刪除。 如果空行只有一兩行的話,可以把鼠標放在空白行上,然后點擊鼠標右鍵,在彈出的菜單中選擇刪除菜單。 在彈出的刪除確定窗口中&am…

Doxygen for C++使用說明——注釋代碼一

寫這一節的時候,我在想網上有眾多的參考文獻,外加官網上的,要是我再將它們重復一遍,也沒什么意思。網上資料很多,但是他們有一個共同的缺點是都是羅列用法,然后顯示效果。這些都是比較散的,我想…

DevOps的前世今生

2019獨角獸企業重金招聘Python工程師標準>>> 目前在國外,互聯網巨頭如Google、Facebook、Amazon、LinkedIn、Netflix、Airbnb,傳統軟件公司如Adobe、IBM、Microsoft、SAP等,亦或是網絡業務非核心企業如蘋果、沃爾瑪、索尼影視娛樂…

【轉】最牛B的編碼套路

最近,我大量閱讀了Steve Yegge的文章。其中有一篇叫“Practicing Programming”(練習編程),寫成于2005年,讀后令我驚訝不已: 與你所相信的恰恰相反,單純地每天埋頭于工作并不能算是真正意義上的…

ecshop 廣告設置

最近公司準備做個商城,讓我從JAVA轉過去,好吧,先看下吧,反正也得做。接到手里的是一套已經成型的模板,但是二次開發必須得了解下機制、文件、響應、設置什么的,也是個新手,寫點東西給后面更新的…

linux 信號_Linux信號機制

信號就是一條消息,通知進程系統中發生了什么事,每種信號都對應著某種系統事件。一般的底層硬件異常是由內核的異常處理程序處理的,它對用戶進程來說是透明的。而信號機制,提供了一種方法通知用戶進程發生了這些異常。例如&#xf…

DOxygen for C++使用說明——添加數學公式

公式 Doxygen允許你把 公式顯示在最終的輸出中(這個功能僅限于HTML和輸出).為了可以在HTML documentation顯示公式(轉化為圖片),你必須安裝以下軟件: latex: 編譯器, 被用來解析公式, 首先提取公式寫到一…

VC2010下Qt5的中文亂碼問題

要搞清楚這個問題,先要弄明白編碼。但是編碼問題實在太復雜,這里肯定講不開。 我先找一個例子,比如:“中文” 的 Unicode 碼點/UTF8編碼/GBK 分別是多少。 先去這個網站,輸入 “中文” 查詢對應的 Unicode 碼點/UTF8編…

Tomcat 的 DefaultServlet

問題描述: 群里有人測試 Spring MVC,沒有配置任何Controller,只配置了一個view resolver,指定了前綴后綴。 然后,他問的是 當訪問 localhost:8080/test 的時候,為什么會被重定向到 localhost:8080/test/ &a…

Python學習(七)面向對象 ——封裝

Python 類的封裝 承接上一節,學了Student類的定義及實例化,每個實例都擁有各自的name和score。現在若需要打印一個學生的成績,可定義函數 print_score() 該函數為類外的函數,如下: 1 class Student(object):2 def …

spss練習數據_SPSS篇——如何在成千上百萬個數據中標識重復個案

本文就帶大家來學習一個小技巧,如何運用SPSS標識重復個案。我們都知道在Excel中,通常會用到“篩選”功能來選出指定條件相同的單元格。那么在SPSS中,如何在成千上百萬個數據中篩選出重復的個案呢? 小編就是要告訴你,幾…

DOxygen for C++使用說明——Markdown支持

自Doxygen 版本1.8.0,Markdown被引進。 接下來,我們將先簡單介紹標準的Markdown語法,讀者可以進入Markdown官網查詢更詳細的細節。然后討論一下Doxygen支持的Markdown擴展,最后討論一下Doxygen對Markdown標準的實現細節。 Stand…

方程式漏洞之復現window2008/win7 遠程命令執行漏洞

前幾天就想寫的,因為一些緣故就沒寫。此次是在外網環境下進行的。大家在內網中也一個樣。 方法: 使用Eternalblue模塊,劍測是否有漏洞然后msf生成一個dll直接反彈shell. PS:win版本的不知道緣何生成出來的dll是0kb 我就在自己本地…

C++空類和string類

1. 空類 1.1 空類默認哪六個成員函數。 1 class Empty2 {3 public:4 Empty(); //缺省構造函數 Empty e;5 Empty( const Empty& ); //拷貝構造函數 Empty e2(e1);6 ~Empty(); //析構函數7 Empty& operator( const Empty& ); //賦值運算符…

客服會話 小程序 如何發起_小程序、公眾號、App三者如何融合布局?這里有一份避坑指南...

對產品經理來說,小程序無疑是2020年最火爆的詞之一了。我們能看到,就在今年疫情期間,小程序DAU達到4.5億,而超市、生鮮果蔬、社區購物等都同比增長100個點左右,小程序的商業價值很明顯地在快速釋放。小程序如此火爆&am…

DOxygen for C++使用說明——注釋代碼二

這一次我在谷歌搜索中檢索到了Doxygen在github的倉庫,進去一看,令人大喜,github倉庫里含有了一個Doxygen的官方配置文件Doxyfile,于是下載下來,發現Doxyfile已經配置了將倉庫中的\src文件編譯成Documentation,并且將結果放在了dox…

python super()(轉載)

一、問題的發現與提出 在Python類的方法(method)中,要調用父類的某個方法,在Python 2.2以前,通常的寫法如代碼段1: 代碼段1: class A:def __init__(self):print "enter A"print "…

Swagger+Spring mvc生成Restful接口文檔

2019獨角獸企業重金招聘Python工程師標準>>> Swagger 是一個規范和完整的框架,用于生成、描述、調用和可視化 RESTful 風格的 Web 服務。總體目標是使客戶端和文件系統作為服務器以同樣的速度來更新。文件的方法,參數和模型緊密集成到服務器端…