转自:http://blog.csdn.net/linqir/article/details/8086974
在写代码的时候,如果按照一定的规范在头文件里写上注释的话,
就可以利用Xcode的文档自动输出功能生成一份完整的HTML项目文档。
生成的格式和Apple Developer网站上的API文档几乎是一样的。
我们来看看如何利用Xcode生成项目文档。
步骤:
1. 在XCode里点击Project,然后点Add Target给项目添加一个TARGET
2. 在添加Target的弹出对话框里,选择Aggregate,点击Next,输入一个你喜欢的名字,点击Finish
3. 你会发现TARGETS下面多了一个项目,点击它,然后在右边点击BuildPhases标签,然后点击Add Build Phase并选择Add Run Script
4. Run Script添加成功后,点击它的下拉菜单,把以下代码拷贝到代码对话框里。
# shell script goes here
mkdir -p headerDoc
find ./HelloPhoneGap/Classes -name \*.h -print | xargs headerdoc2html -o headerDoc
gatherheaderdoc headerDoc
exit 0
注意:代码里的./HelloPhoneGap/Classes是你的类文件的保存的路径,请根据各自情况修改。
5. 在XCode左上角的Scheme里选定刚才生成的Target,然后点Run。
运行以后,在你的项目文件夹里,就会生成一个文档文件夹了。
这些自动生成的文档都是根据你在源代码里写的注释生成的。
下面就详细介绍一下各种能自动生成文档的注释
■ header : 头文件基本信息。这个用在每个源代码文件的头文件的最开头。
例如:
@header 这里的信息应该与该源代码文件的名字一致
@abstract 关于这个源代码文件的一些基本描述
@author Kevin Wu (作者信息)
@version 1.00 2012/01/20 Creation (此文档的版本信息)
*/
■ class: 类信息。此注释用在类声明的开头。
例如:
@class
@abstract 这里可以写关于这个类的一些描述。
*/
@interface MyClass : NSObject {
}
■ property: property的相关注释。
@property
@abstract 这里可以写关于这个Property的一些基本描述。
*/
@property (nonatomic,readonly) NSString *helloDocText_;
■ method: 函数(方法)的相关注释。
@method
@abstract 这里可以写一些关于这个方法的一些简要描述
@discussion 这里可以具体写写这个方法如何使用,注意点之类的。如果你是设计一个抽象类或者一个
共通类给给其他类继承的话,建议在这里具体描述一下怎样使用这个方法。
@param text 文字 (这里把这个方法需要的参数列出来)
@param error 错误参照
@result 返回结果
*/
- (BOOL)showText:(NSString *)text
error:(NSError **)error;
■ enum: enum的相关注释。
@enum
@abstract 关于这个enum的一些基本信息
@constant HelloDocEnumDocDemoTagNumberPopupView PopupView的Tag
@constant HelloDocEnumDocDemoTagNumberOKButton OK按钮的Tag
*/
typedef enum HelloDocEnumDocDemo_{
HelloDocEnumDocDemoTagNumberPopupView = 100,
HelloDocEnumDocDemoTagNumberOKButton,
}HelloDocEnumDocDemo;
■ category: category的相关注释。
@category
@abstract NSString的Category
*/
@interface KevinNSString (NSString)
■ protocol: protocol的相关注释
@protocol
@abstract 这个HelloDoc类的一个protocol
@discussion 具体描述信息可以写在这里
*/
@protocol HelloDocDelegate <NSObject>
以上列举的标准注释也许并不完善。
具体请参考苹果的developer网站的API文档。
以上列举的标准注释全都在下面的头文件里,仅供参考。
相关推荐
最值得注意的是, 用于生成Xcode项目文件,而用于生成语法突出显示的Swift代码。 目录 :warning: 本文档正在进行中。 安装Bootstrapp Bootstrapp是常规的macOS应用/Applications ,照常通过将应用程序捆绑包拖到/...
jazzy生成的文档在外观和感觉上很有苹果官方文档的风格,支持标准的Objective-C和Swift文档注释语法,使用了HTML模板,利用了Clang AST和SourceKit的强大和精确,支持Xcode和Dash文档设置,并且还支持Objective-C和...
最小的iOS Gyp Builder 碰巧我想摆脱Xcode .pbxproj文件的地狱。 因此,我尝试将GYP用作开发工作流程。 这是POC项目。用法安装GYP brew tap jonmorehouse/tapbrew install gypmake gyp生成XCodeProj gyp hello-ios....
ArcGISRuntime for iOS v2.2支持iOS SDK 4.X及以上版本,同时要求终端的操作系统也是4.X及以上版本,另外由于2.2版本中用“ArcGIS.Framework”取代了之前的静态库“libArcGIS.a”的,所以原有的项目如果要升级到2.2...
利物浦doc 0.联系人,参与者和链接 前端开发人员: 斯蒂芬·图尔琴科(Stepan ... ios-(用于发布到应用商店的ios项目xcode目录) README.md-(本文档) App.tsx-(输入应用程序点和提供程序) SCR api-(文件服务
要使用演示项目,只需使用 XCode 5+ 打开它并构建。执照版权所有 (c) 2011-2013 Carson McDonald 特此免费授予获得此软件和相关文档文件(“软件”)副本的任何人无限制地处理软件的权利,包括但不限于使用,复制,...
链接套件适用于iOS SDK。 链接概念的概述可以在上找到。 所有特定于iOS的文档,集成指南和测试计划都可以在上找到。 LinkKit SDK作为此回购中附加到发行版的zip文件分发。...创建一个Xcode项目要生成并打开Xcode项
执行项目中的ExportFramework脚本自动生成框架 创建一个Cartfile ,在这个文件中列出你想使用的框架 github "easyui/EZPlayer" 运行carthage update ,获取依赖到Carthage / Checkouts文件夹,逐个生成 在工程的...
这是一个多合一的项目,因此构建过程只需单击xcode中的一个即可。 应用程序沙箱中的“文档”文件夹将自动安装为磁盘c。 您可以在“文件应用程序->在我的iPad / iPhone上”中访问此文件夹。 在macOS catalina上,您...
信息休息 面向iMessage的高性能,功能齐全的REST API...对于iOS,将生成一个.deb文件,可以将其安装以自动执行安装过程。 对于macOS,没有自动安装过程。 手动安装的唯一方法是将Staging/Library/Preferences/com.app
欢迎来到Emcee项目,这是在本地和许多Mac上并行运行iOS测试的最终解决方案。 Emcee允许您在许多物理计算机上运行UI测试,以分配工作并更快地获得测试结果。 共享队列管理测试执行的顺序。 司仪工作人员自动执行测试...
by 编写文档对于开发来说非常重要,但是使用 Xcode 真的很痛苦。 想想您在按“*”或“/”并一遍又一遍地键入参数方面浪费了多少时间。 现在,您可以找到要记录的方法(或任何代码),然后输入/// ,将为您生成文档...
DTCoreText 该项目旨在复制Mac OSX上存在的方法,...文献资料可以文档,也可以通过将其安装在Xcode Organizer中。 回答一些常见问题。 变更日志: 还有[编程指南](文档/编程指南-template.markdown),其中包含针对常
Azure Pipelines状态(生成和测试) 分支地位掌握 开发者 App Center构建的iOS 安卓阿尔法(Dev) 贝塔 预生产 生产 发展 先决条件Visual Studio 2019 Xcode 12或更高版本(仅适用于iOS) 入门使用git clone ...
2.1 在Xcode中设置项目 8 2.2 Interface Builder简介 13 2.2.1 nib文件的构成 14 2.2.2 在视图中添加标签 15 2.3 美化iPhone应用程序 17 2.4 小结 20 第3章 处理基本交互 21 3.1 MVC范型 21 3.2 创建项目 22 3.3 ...