Xcode 注释与标注

更多关于注释与标注的内容
也请各位大佬提示补充

1、普通注释

//单行注释1
/// 单行注释2
/**
 * 多行注释
 */

单行注释2和多行注释,添加到方法前写注释。在调用方法时,会显示注释内容预览。

2、使用特殊注释或标注:

  // MARK: - MARK 说明文字,带分割线
  // TODO: - TODO
  // FIXME: - FIXME
  // !!!: - !!!  (//与!!!之间必须有空格或者一个以上的字符,才能显示)
  // ???: - ???
  #pragma mark - 测试
  #pragma - 测试

对应效果如下:


截屏2019-11-26上午9.55.56.png

截屏2019-11-26上午9.54.37.png

使用以下两个注释时:

 #pragma mark - 测试
 // MARK: - MARK 

将鼠标箭头放置在Xcode右侧小地图(minimap)上,按住win键。可显示所有方法及特殊标注。如下图:
截屏2019-11-26上午9.51.00.png

下图的代码区域的两条横向分割线来自于标注:

// MARK: - MARK 说明文字,带分割线
#pragma mark - 测试1

必须添加中间的”-“,-左右两侧有无空格,不影响。


截屏2019-11-26上午9.54.12.png
@property (nonatomic, copy) NSString * _Nonnull mNum;///我的数量
@property (nonatomic, copy) NSString * _Nonnull num;///<他人数量

/// 的注释方式,会作为下一行的描述简介,出现在快速预览里。
///<的注释方式,会作为当前行的描述简介,....。优先级高于///。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容