doxygen
在Linux下面開發(fā)，在代碼中一般注釋doxygen格式的注釋，這是幫助我們生成文檔的一個好方法。
對于doxygen的主要是語法，網(wǎng)上有很多的說明，有個工程：GNOME Power Manager里面的doxygen
注釋寫的非常好，你們可以下載下來看看，并且可以借鑒到自己的實際開發(fā)中。
這里我想說的是：如何從source code 總提取開源軟件的文檔。
有3個工具可以先安裝一下：
1 doxygen
2 Graphviz
3 htmlhelp
1 doxygen是大名鼎鼎代碼文檔工具。
下載地址：www.doxygen.org
安裝它。
2 Graphviz
這個工具配合doxygen使用，可以提取函數(shù)，模塊之間的調(diào)用關(guān)系，非常清晰。
下載地址：http://www.graphviz.org/Download..php
下面是Graphviz提取出來的一些關(guān)系圖：
3 htmlhelp
這個工具把doxygen生成的html文件，轉(zhuǎn)化為一個CHM文件，看起來方便些。
下載地址：http://www.softpedia.com/get/Authoring-tools/Help-e-book-creators/HTML-Help-Workshop.shtml
安裝它。
4 我們以GNOME POWER Manager為例，看看如何使用這些工具，提供我們的文檔能力。
源碼下載地址：
http://www.gnome.org/projects/gnome-power-manager/
下載源碼，解壓后，我們來看看如果使用上面的3個工具：
首先用doxygen:
生成的幫助文檔里面帶有，call graph.
接著用htmlhelp workshop:
生成的CHM文件：
以及各個調(diào)用關(guān)系，一目了然：
從生成的代碼注釋上看，GNOME Power Manager對于注釋用的是非常好的，這可以用到我們的實際開發(fā)中。
另外GNOME Power Manager是對GObject用的最好的，大家也可以借鑒其用法。