直接使用Xcode生成注释和文档
好的程序一定包含文档和注释,不仅容易看懂,容易维护,也是团队沟通的基础
Xcode可以直接生成注释和文档,方法如下
1. 在.h文件中按规范声明,如声明一个函数严格按照如下格式
注意: +/-号后面一定要跟一个空格
2. 选定你要注释的函数,然后选择Xcode的菜单 [Script icon] -> HeaderDoc -> insert @method template 如图

然后代码中会生成规范的注释

于此类推,也可以生成@class, @protocol等注释
3. 有完整的注释就能生成文档,方法
在你的项目文件夹中运行
便可以在hdoc文件夹中生成像Cocoa API Documents一样的文档,为了方便你可以新建一个Shell Script target,这样你能在xcode中就很方便地生成文档。

游击队也要在战斗中学习如何成为正规军,大家继续努力
Xcode可以直接生成注释和文档,方法如下
1. 在.h文件中按规范声明,如声明一个函数严格按照如下格式
- (NSString*) stringForNumber:(double) f;
注意: +/-号后面一定要跟一个空格
2. 选定你要注释的函数,然后选择Xcode的菜单 [Script icon] -> HeaderDoc -> insert @method template 如图

然后代码中会生成规范的注释

于此类推,也可以生成@class, @protocol等注释
3. 有完整的注释就能生成文档,方法
在你的项目文件夹中运行
headerdoc2html -o hdoc *.h
gatherheaderdoc hdoc
便可以在hdoc文件夹中生成像Cocoa API Documents一样的文档,为了方便你可以新建一个Shell Script target,这样你能在xcode中就很方便地生成文档。

游击队也要在战斗中学习如何成为正规军,大家继续努力












