团队中的代码规范始终是件不能忽略的事情。这篇文章介绍了Code Snippet的相关内容,以及在代码规范中所发挥的作用。
什么是Code Snippet?
Xcode Code Snippet是一种拥有代码自动补全功能,可以保存常用的代码,可以方便的重用这些代码。
如何添加Code Snippet?
1. 选中代码,右键选择 Creat Code Snippet

2. 选中代码,Editor-Creat Code Snippet

然后输入Title、Summary,选择Language、Platform、Completion、Availability,点击Done即可。
在代码内容中如果有需要修改的地方可以用<#参数名#>代替,
Title:代码片段的标题
Summary:代码片段的描述
Language:代码片段的可用语言
Platform:代码片段的可用平台
Completion:代码片段的快捷键,输入该内容将有代码补全提示。
Availability:代码片段的可用位置

如何查看代码片段?
可通过添加的方式进入查看界面,但会增加一条无用代码片段。
正确的姿势:
1、是通过Xcode 12右上角的+号进入,然后可以搜索自己想要的代码片段。如果想要删除或编辑,选中目标代码片段,点击Delete或Edit即可。
2、通过View -> Show Libary
Code Snippet存哪了?
/Users/awnlab/Library/Developer/Xcode/UserData/CodeSnippets目录下,
如何查看Xcode的默认存储目录?可以通过Xcode -> Preferences… -> Locations中。
Code Snippet的好处?
快捷输入,代码重用,统一代码规范。
统一代码规范如何实施?
主要通过整理、管理和使用。
- 将属性、变量、方法、等常用代码整理成Code Snippet,例如:pstring=@property (nonatomic, copy) NSString *<#name#>;
- 将公共组件使用代码整理成Code Snippet,例如:基础UI组件,公共日志组件等。
- 各模块提供对外调用的常用Code Snippet。
- 统一管理,gitlab统一管理Code Snippet,可用一个标记版本。
- 对外输入Code Snippet文档,组内学习并使用。