iOS API接口注释规范

说明

AppleDoc支持多种注释方式,这里只介绍一种自认为最简单合适的方法,通过其他关键字如@discussion @brief也能达到类似的效果,这里不做一一介绍。

Example



#import <Foundation/Foundation.h>

/**这里是枚举的简介
  
  这里是枚举的详述,枚举的开头注释要采用多行注释,多行注释必须以斜杠加两个星号开头,以一个星号加斜杠结尾,中间每一行不需要加星号。详述与上面简介需要有一个空行。

  详述可以省略

  @warning 可以省略,如果有一些需要提醒用户的地方可以用`warning`提醒,另外,如果有内容变更也可以通过这种方式体现
  @warning `warning`可以写多个,生成html中会分多个`warning`进行显示
  @since v5.4.0
 */
typedef NS_ENUM(NSInteger, TestEnum) {
    /**
      这里是这个枚举的简介

      这里是这个枚举的详述,可以省略,如果有,则需要与简介隔一行
      
      @since v5.4.0
     */
    TestEnum1 = 0,

    /**
      这里是这个枚举的简介

      这里是这个枚举的详述,可以省略,如果有,则需要与简介隔一行
      
      @since v5.4.0
      @deprecated v5.5.0
     */
    TestEnum2 = 1 DEPRECATED_ATTRIBUTE,

};



/**
  类的开头注释与枚举的开头注释相同
  
  类的开头注释中还可以对类中的方法和属性进行引用达到链接的效果`propertyNew`
  
  类的开头注释中可以增加代码实例(注意下面代码前后要有空行,且需要缩进):

    TestAppleDoc *appleDoc;
    appleDoc.propertyNew = @"appledoc";

  但是不能出现类中不存在的方法,如`alloc, init`,虽然是系统方法,但`appledoc`并不认,会报错
  
  @since v5.4.0
 */
@interface TestAppleDoc : NSObject

///---------------------------------------------------------------------------------------
/// @name properties
///---------------------------------------------------------------------------------------

/**
 属性的注释

 关于属性的描述,替代`propertyDeprecated`

 @since v5.5.0(表示从5.5.0版本新增)
 */
@property (nonatomic, copy) NSString* propertyNew;

/**
 如果接口或属性被废弃,则在简介或详述中说明这是一个被废弃的属性,请使用`propertyNew`
 
 @since v5.3.0(表示从5.3.0版本新增)
 @deprecated v5.5.0(表示从5.5.0版本废弃)
 */
@property (nonatomic, copy ,readonly) NSString* propertyDeprecated DEPRECATED_ATTRIBUTE;

/**
  这是一个枚举属性,下面`@see`可以链接到`TestEnum`的定义

 @see TestEnum
 @since v5.4.0
 */
@property (nonatomic, assign) TestEnum te;


///---------------------------------------------------------------------------------------
/// @name methods
///---------------------------------------------------------------------------------------


/**这里是方法简介

 这里是方法详述,与上面简介需要隔一行,在这里可以描述方法的详细用法

 @param te `TestEnum`类型参数
 @return 返回`uSDKDeviceInfo`实例
 @warning v5.4.1版本中接口发生变化,需要先xx,再调用该方法才能生效(即可以通过该方式声明接口变更)
 */
- (instancetype)initWithTestEnum:(TestEnum)te;

@end


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容