用doxys生成C++文档

写C++代码，写注释，然后自动生成文档，这是任何一个规范的C++开发流程都必须的。今天试了一下doxys，挺好用的。

在Ubuntu机器上，先下载Linux版的doxys程序，网址在：http://www.doxys.dk/doxys_homepage/homepage/Download/Download0_dir_description.html

解压

tar jxvf doxys_1_15_linux32_bin.tar.bz2

然后进入该目录，用root权限运行

./install_RunAsRoot.sh

安装完成。

现在进入C++项目目录，在顶层目录就好。然后运行doxys，会自动扫描目录结构，提取comments，生成html文档。所有的文档都会创建在doxys_docs目录下。

最后，doxys要求的comments书写格式有点特别，参考这里：http://www.doxys.dk/doxys_homepage/homepage/Documentation/Example_Code/HowToDocument0_class_description.html

和我用的Google c++ style的要求// 不一样。在找到能够提取google c++ style的comments之前，先委屈一下，就用///吧。

或者采用Java风格：

/**

*/

现在看一下生成的文档中包含的类继承关系图，还是不错的吧。

注释中如何描述参数和返回类型，我选择了Java风格。参考文档：

http://www.doxys.dk/doxys_homepage/homepage/Documentation/Example_Code/ParametersJavaStyle4173613626_member_description.html

相关阅读：