利用doxygen提高源代码阅读效率

阅读开源项目的源代码是提高自己编程能力的好方法，而有一个好的源代码阅读工具无疑能够让你在阅读源代码时事半功倍。之前找过不少源代码阅读工具，像SourceInsight、sourcenav、scitools等，但是这些工具要么是收费的，要么只有windows版本。sourcenav虽然是开源的，但是个人觉得不是很好用。直到最近毕设时老师要求用doxygen生成代码文档，在使用doxygen的过程中，突然发现这个东西配合上浏览器其实就是一个很好的源码阅读工具，所以给大家推荐一下。

 

废话不多说，相信大家都知道doxygen是一个用来生成源码文档的工具，不少有名的开源项目想opencv，boost都是用它来生成文档的。虽然正常要生成一份详细的文档需要我们在代码中按照一定格式写注释，但是doxygen也能够从没有这些注释的源码中抽取出函数定义、类定义、变量定义、宏定义等信息，并且能够提供交叉引用，为我们阅读代码提供方便。我这里用一个开源项目Google Protobuf来做一下演示。

首先按照安装教程（http://www.stack.nl/~dimitri/doxygen/manual/install.html）安装好doxygen。

进入存放项目的目录，运行doxygen -g命令，生成Doxygen配置文件Doxyfile

Doxygen配置文件默认名为Doxyfile，这里面是一些格式为 KEY  =  VALUE的键值配置属性，如下图。每一个属性前都有相应的说明，doxygen会根据这些配置属性来生成文档。

我们要编辑器打开Doxyfile后设置如下属性 (因为文件比较大，需要使用编辑器的查找功能找到这些属性。

INPUT = protobuf-2.5.0/src  （设置项目源代码目录的路径，相对于Ｄoxyfile的位置）

PROJECT_NAME = "ProtoBuf"  （项目名默认为My Project)

OUTPUT_DIRECOTRY = doc     (设置文档输出路径，相对于Ｄoxyfile的位置）

RECURSIVE = YES            （设置递归查找所有子目录，默认NO只查找当前目录）

EXTRACT_ALL = YES           (设置抽取代码中所有实体，默认NO只抽取有doxygen注释的实体）

SOURCE_BROWSER = YES        （生成交叉引用）

INLINE_SOURCES = YES         （将源代码包含进文档，默认NO只包含声明，不包含定义）

OUTPUT_LANGUAGE = Chinese    （设置文档语言为中文)

 

设置后保存，运行doxygen命令生成文档。

可以看到当前目录多除了doc/html,和doc/latex目录，分别包含了html格式和latex格式的文档。我们在doc/html目录下用浏览器打开index.html。可以看到代码实体按命名空间，类，文件三种方式组织。其中类可以查看类列表，类索引，类继承关系，和类成员等。

我们选择google::protobuf::internal::ExtensionFinder类看看具体信息。

可以看到类继承关系图，成员函数，详细描述下还有成员函数的函数原型和跳转到函数定义的链接（截图比较大就不发了）。

其中蓝色的链接点击后可跳转到函数的具体实现处。

可以看到在查看具体实现时，所有的蓝色链接都代表了项目中定义的实体，如函数，类，成员等。鼠标悬浮上可以看到简要信息，也可以点击跳转到详细信息。这样在看源码时遇到一个不清楚的东西就能够随时看到它的定义。再配合上浏览器原有的返回，跳转，在新标签打开页面等功能，阅读源码就变得十分方便了。

好了，我的介绍就到这，有兴趣的朋友可以自己试一试，谢谢~