Xcode 快速添加类、方法、变量的文档注释说明

IDE 2020-03-10 阅读 54 评论 0

使用 Xcode,为类 interface、函数、变量、协议等等,添加文档注释,在编写代码可以快速查看,提高开发效率。可以使用2种方法添加。

1. 使用快捷键

 ⌘ command+⌥ option+/ 

2. 使用菜单栏

Editor -> Structure -> Add Documentation

查看文档

文档注释为3个斜杠 ///开头。如:

/// 添加文件
/// @param key 传输文件的key
/// @param path 文件路径
-(void)addFormFile:(NSString *)key path:(NSString *)path;

查看文档可以将鼠标移动方法的位置,按住  ⌥ option,左键点击鼠标。

查看方法的文档说明

最后更新 2020-03-10