iOS 技术文档 - 使用Doxygen最详解

Hi，

作为一个有责任，有理想的程序猿，代码注释，是必须要的。

如何将你的代码和注释，提炼出来，生成一份技术文档？

本文主要讲的是使用Doxygen ,来完成iOS文档的生成。当然，android、java等也可以使用。

安装Doxygen

我安装都选择官网：http://www.stack.nl/~dimitri/doxygen/download.html

下载下来是dmg文件，可以直接安装到Mac上。

使用Doxygen

打开程序，如下：

Wizard方式：

project，如上图显示，

红色部分是我配置的，依次是：文档导出文件夹、项目名称、作者、版本、项目源码路径。然后点击next。

Mode，如下图显示，

红色部分，是我配置的：

Output的配置，如下图所示：

红色部分是我的配置

Diagrams,如下图所示：

以上配置，已经ok，然后next，如下图所示：

点击'Run doxygen'就可以了。

Expert模式

该模式是更详细的配置，一般用不到。

有一个地方，做sdk时会用到，就是排除实现文件，不对外公布。例如iOS，会排除.m文件。

如下图所示，1中是扫描的文件，2中是排除的文件

功能还有很多，想了解更多，你可以多尝试，还可以去官网看看。

查看生成的文档

如下图所示，是文件夹结构，我开始以高德地图sdk文档为标准，所以也以它展示：

打开index.html，我们的文档内容如下：

还是可以的，对外使用，已经够了。

我说下不好用的地方，展开Class List，

对于iOS代码来讲，这一大堆的类，看着就蛋疼。

有没有一种方法，让这些类分模块来展示？

我做了尝试，在Doxygen程序中，是没法处理的，只能通过代码注释来实现此功能。

查看官方文档：http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#modules

找到一种方式，使用module（模块）的形式，可以做到类的分组。

方法如下:

使用Module来实现类的分组

1> 定义一个模块

IntVariables 这个模块的唯一标识，

Global integer variables 模块在文档中展示的名字

/**

* \defgroup IntVariables Global integer variables

* @{

*/

举个例子，比如：登录模块，可在这个模块的一个头文件中（一般模块都会有），或者随便一个文件中（不建议），添加如下模块的定义

/**

* \defgroup dg-1  登录

* @{

*/

2>，将相关文件添加到该模块中

然后有好几个类，都是登录相关的，可以在每个类的声明（@interface）上面，添加

/** @ingroup dg-1

*  @brief 这个类的功能简介

*/

至此，把登录模块单独提出来了。

生成文档中，多了一个模块的展示，模块中有了登录，如下所示：

我想到的常用的注释，除了xcode自带的注释，多了一个模块功能的注释，所有我在xcode中加了代码块，来方便使用。

自动化生成文档

目前还没排期，没时间搞了，官方有具体的脚本，可以加到xcode中。

其实多做的工作，就是规范一下自己的代码，添加注释，效果却很理想，何乐不为。