iOS规范注释格式

兼容 Headerdoc 和 Appledoc 和 Doxygen

头文件的第一行

/*!
 *  @header   头文件名称
 *  @abstract 功能描述
 *  @author   创建者
 *  @version  版本
 */

Class类 & Protocol协议 & Category分类 & Property属性

类声明的上一行

1
2
3

/*!
 *  功能描述
 */

/*!
*  枚举描述
*/
typedef enum{
    枚举类型,    /*! 类型说明 */
    枚举类型     /*! 类型说明 */
}枚举名称;

/*!
 *  方法说明
 *  与上一行没有空行，内容在上一行的同一行显示
 *
 *  与上一行有空行，内容在上一行的下一行显示
 *
 *  @param 参数 参数说明
 *  @param 参数 参数说明
 *
 *  @return 返回值说明
 */

比较习惯用VVDocumenter

我自己fork了一份，加上了头文件注释的代码，使用方法在头文件第一行连续输入“///”，前面不要有空格，下载地址
用Xcode打开工程，编译Command+B, Build成功后，可以在~/Library/Application Support/Developer/Shared/Xcode/Plug-ins目录下看见新生成的xcplugin
重启Xcode, 如果有提示是否load, 选择load
默认在代码中要加注释的地方输入”///“会默认生成注释格式，可能跟上述的有出入，上述是为了兼容三种工具有所调整
在Xcode菜单->Window选项->VVDocumenter 设置属性

Xcode->Targets->Aggregate->Run Script

添加以下代码

mkdir -p 路径
find 头文件搜索路径 -name \*.h -print | xargs headerdoc2html -o 输出路径
gatherheaderdoc 输出路径
exit 0

安装

1
2
3

git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh

验证是否安装成功

1	appledoc --version

Xcode Script

Xcode->Targets->Aggregate->Run Script

1	appledoc --project-name "${PROJECT_NAME}" --project-company "hyphenate" --company-id "com.hyphenate" --output 输出路径头文件搜索路径