文档章节

xcode headerDoc 注释及自动生成文档。

abcMx
 abcMx
发布于 2014/09/02 11:26
字数 392
阅读 57
收藏 0



http://kevin-wu.net/how-to-create-documentation-with-xcode/



规范注释生成器VVDocumenter + OSX 10.9.2

http://blog.csdn.net/jymn_chen/article/details/21452195


http://www.cnblogs.com/ygm900/p/3611232.html


通过右下角  show code snippet 创建自定义注释,可编辑快捷键。

将注释选中拖动到 show code snippet 然后编辑即可 创建一个新的快捷键。

http://www.th7.cn/program/ios/201408/263758.shtml

写函数时,提示的占位符 用这个语法即可   <#text description#>    text description为提示占位符


headerDoc 注释示例

/*!

 @header HellocDoc.h

 @abstract aboutDiscription

 @author Kevin Wu (作者信息)

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

 */



#import <Foundation/Foundation.h>


/*!

 @enum

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

 @constant HelloDocEnumDocDemoTagNumberPopupView PopupViewTag

 @constant HelloDocEnumDocDemoTagNumberOKButton OK按钮的Tag

 */

typedef enum HelloDocEnumDocDemo_{

  HelloDocEnumDocDemoTagNumberPopupView = 100,

  HelloDocEnumDocDemoTagNumberOKButton,

}HelloDocEnumDocDemo;




/*!

 @protocol

 @abstract 这个HelloDoc类的一个protocol

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

 */

@protocol HelloDocDelegate <NSObject>


@end



/*!

 @class

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

 */

@interface HelloDoc : NSObject {

}



/*!

* @property

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

*/

@property (nonatomic,readonly) NSString *helloDocText_;




/*!

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

* @discussion 这里可以具体写写这个方法如何使用,注意点之类的。如果你是设计一个抽象类或者一个

* 共通类给给其他类继承的话,建议在这里具体描述一下怎样使用这个方法。

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

* @param error 错误参照

* @result 返回结果

 */

- (BOOL)showText:(NSString *)text

           error:(NSError **)error;


@end



/*!

 @category

 @abstract NSStringCategory

 */

@interface KevinNSString (NSString)


@end


© 著作权归作者所有

abcMx
粉丝 15
博文 184
码字总数 63849
作品 0
无锡
程序员
私信 提问
利用HeaderDoc自动生成API文档

利用HeaderDoc自动生成API文档 最近在为公司写框架和组件库。大家都建议在文档上需要更加完善一些。于是在思考如何规范地完善文档? 面向非技术型的boss们的说明性文档,手工写即可。面向组件...

我是IT码农
2016/03/29
183
0
IOS项目自动生成技术文档很方便实用

Xcode工具本身不具备这样的功能,但是我们通过一些插件和工具来达到这个目的。 生成注释 生成文档之前,我们需要给代码中的方法或者变量写上注释,然后再利用工具根据这些规范的注释自动生成...

田广ly
2016/03/18
217
0
修改Xcode自动生成的文件注释来导出API文档

修改Xcode自动生成的文件注释来导出API文档 最近工作需要和其他公司进行项目交接的时候,原以为像往常一样直接交付源代码就行了,谁知道客户公司需要我们提供API文档。瞬间我和小伙伴们都惊呆...

法斗斗
2016/05/30
81
0
IOS Android项目注释规范

场景描述:最近整理公司开发的项目,发现公司项目很多地方写的不规范,尤其是注释;这对以后维护和开发带来了很多不便。尤其对于对项目本身不熟悉的人,在没有注释的情况下看项目会很费劲,通...

malawo
2013/08/17
1K
0
iOS生成标准的注释工具——VVDocumenter

iOS生成标准的注释工具——VVDocumenter 在程序开发中,我们免不了要写许多注释,方便帮别人也方便我们自己以后检查我们的代码。然而,写注释是一件十分浪费我们时间与精力的事,要写符合文档...

珲少
2015/09/16
2.1K
0

没有更多内容

加载失败,请刷新页面

加载更多

Eureka应用注册与集群数据同步源码解析

在之前的EurekaClient自动装配及启动流程解析一文中我们提到过,在构造DiscoveryClient类时,会把自身注册到服务端,本文就来分析一下这个注册流程 客户端发起注册 boolean register() t...

Java学习录
7分钟前
1
0
Java描述设计模式(15):责任链模式

本文源码:GitHub·点这里 || GitEE·点这里 一、生活场景描述 1、请假审批流程 公司常见的请假审批流程:请假天数 当 day<=3 天,项目经理审批当 3<day<=5 天,部门经理审批当 day>5 天...

知了一笑
18分钟前
3
0
总结:数组与链表

1、内存申请:数组在内存上是连续的空间;链表,内存地址上可以是不连续的。 2、查询速度:数组可以随机访问,链表必须顺序访问,即从首个元素开始遍历,逐个查找,所以数组查询很快。 3、写入...

浮躁的码农
26分钟前
3
0
HashMap源码分析

read

V丶zxw
45分钟前
5
0
Python字符串或JSON字符串转字典dict、列表list

有3种方法 1、使用ast模块 >>> import ast>>> s = '["test",1]'>>> ast.literal_eval(s)['test',1]>>> s = '{"test":1}'>>> ast.literal_eval(s){'test': 1} 2、eval函数,这个......

编程老陆
今天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部