Xcode自动生成文件注释文档

今天折腾了适用于.h文件的注释：

- 导出注释标准

/*! 头文件基本信息。这个用在每个源代码文件的头文件的最开头。

@header 这里的信息应该与该源代码文件的名字一致

@abstract 关于这个源代码文件的一些基本描述

@author Sindri Lin (作者信息)

@version 1.00 2012/01/20 Creation (此文档的版本信息)

*/

/*! 类信息。此注释用在类声明的开头。

@class

@abstract 这里可以写关于这个类的一些描述。

*/

/*!

@property property的相关注释。

@abstract 这里可以写关于这个Property的一些基本描述。

*/

/*!

@method 函数(方法)的相关注释。

@abstract 这里可以写一些关于这个方法的一些简要描述

@discussion 这里可以具体写写这个方法如何使用，注意点之类的。如果你是设计一个抽象类或者一个共通类给给其他类继承的话，建议在这里具体描述一下怎样使用这个方法。

@param text 文字 (这里把这个方法需要的参数列出来)

@param error 错误参照

@result 返回结果

*/

/*!

@enum enum的相关注释。

@abstract 关于这个enum的一些基本信息

@constant HelloDocEnumDocDemoTagNumberPopupView PopupView的Tag

@constant HelloDocEnumDocDemoTagNumberOKButton OK按钮的Tag

*/

/*!

@category category的相关注释。

@abstract NSString的Category

*/

/*!

@protocol protocol的相关注释

@abstract 这个HelloDoc类的一个protocol

@discussion 具体描述信息可以写在这里

*/

修改Xcode自身生成的文件注释

修改之后，生成的模板可以直接生成注释模板

首先右键Xcode -> 选项 -> 在Finder中打开 -> 右键 -> 显示包内容

Contents -> Developer -> Platforms -> iPhoneOS.platform -> Developer -> Library -> Xcode -> Templates -> File Templates

选中Source -> Cocoa Touch Class.xctemplate

包括FILENAME、PROJECTNAME、FULLUSERNAME、DATE和COPYRIGHT，分别表示的是文件名、项目名称、系统用户全称、当前日期和版权声明，这些宏定义可以用在我们修改之后的注释中



需重启

导出文档

首先在选择项目，然后add new target -> Other -> aggregate -> 命名 -> 创建完毕

在建好的run script中填写下面的信息（build phases —> run script）

shell script goes here

mkdir -p headerDoc

mkdir -p headerDoc

find /Users/shuaidan/gimi/myGit_gimi/demo/myFrameWorkDemo（项目绝对路径） -name ‘*.h’ -print | xargs headerdoc2html -o headerDoc

gatherheaderdoc headerDoc

exit 0



纠结了许久，原来 HeaderDoc和Doxygen都不支持Swift； 正在找方案…..