Objective-C 注释文档笔记

996 阅读1分钟

本文写作于2020年10月27日,代码环境为Xcode12,iOS14系统,Objective-C语言

类注释

/**
描述,如何使用该类
 
详细描述,使用该类是具体几种形式
 
- 描述1
 
- 描述2
 @warning 警告,使用时不要做xxxx
 @note 需要注意的事项
 */
@interface ViewController : UIViewController
@end

方法注释

/// 判断xxx是否满足条件
///
/// 详细描述一下该方法使用注意事项
/// @param num 参数num
/// @param obj 参数obj
/// @return YES:满足;NO:不满足
/// @warning 警告,注意不要xxx
- (BOOL)isQualifiedByA:(NSUInteger)num andB:(NSObject *)obj;

Deprecated使用

未完待续

参考