產生 C++ 類文檔及關係圖的方法

來源:互聯網
上載者:User

寫了一大堆的代碼,要產生 C++ 類的文檔及關係圖怎麼辦呢?對,就是產生 MFC 類庫那樣讓人賞心悅目的東西。

總體來說,產生這種文檔有三種思路:

  1. 用 Doxygen 來自動產生文檔

    用 Doxygen 可以跨平台,在維護代碼的同時,維護文檔,很方便很實用。

    如果需要產生類的關係圖,可以用 Doxygen 配上 Graphviz,安裝好 Graphviz 後,需要把該可執行目錄添加到系統的 Path 裡,這樣在 Doxygen 裡就可以用 Graphviz 來產生類的關係圖。

    如果是在 vim, Emacs 這類文字編輯器裡,則可以很自然地使用宏操作來插入 Doxygen 注釋;如果是用 Visual Studio 的話呢,也是可以用 DoxyComment add-in for Visual Studio 2005 之類的東西來完成。

    用 Doxygen 來產生文檔有一個要注意的地方,原始碼檔案的編碼和 Doxygen 選用的字元編碼需要一致,否則產生的文檔會亂碼。現在這個年代,當然是統一用 UTF-8 好一點了。

  2. 用 Visual Studio 的 Class Diagram

    MSDN 上專門有關於使用 Class Diagram 的介紹。

  3. 用 Visio 來畫 UML 圖,純人肉體力活,累,難與代碼同步,不推薦使用。
相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.