项目快结束了。这个阶段需要把原来的代码规范一下,删除测试代码,增加注释,和格式化代码。过程中为了方便,我也找了一下增加效率的方法,整理记录一下。
一、注释
通常我们在 xcode 中需要注释掉代码,单行或者多行时,会选中一行或者多行,直接快捷键 Command + / 键来完成。
而当我们需要对某个方法注释说明,简单的情况是两条斜杠加我们所需要添加的内容,但这种方式的缺陷在于,我们调用这个方法的时候并不能直接看到注释,需要按 command 点击方法跳转到目标方法才可以看到注释。
更好的方法是添加注释块。在 xcode 10 以前需要我们手动编辑格式在拖入 xcode 的代码片段库,但在新的版本里,他已经被添加到快捷方法上了。我们只需要选中方法,使用快捷键 command + alt + /:
当我们把内容都填充完毕,调用这个方法时就会显示:
注释方法可以让后续的开发人员更轻松的读代码,但如果一个类里存在着同一类别的方法,比如 tableview 的代理方法,对同一个对象的操作方法等等,这时我们就可以用到:
1 |
在同类方法的第一个方法前输入,用以对方法集进行分割。使用简单易上手。
二、用 Clang Format 自动进行iOS代码格式化
1.基本用法
1)github 下载Clang Format ,cmd+r 运行安装
2)在工程目录或者workspace目录下创建一个”.clang-format”文件,(『终端』, cd /Users/xxxx/ )
3)vi .clang-format,将以下配置插入”.clang-format”文件:
(这里的风格我设置成大括号一律另起一行,若不符合你的代码风格,可修改该配置自定义风格)
1 |
|
4)wq,保存并关闭 .clang-format
5)Xcode,选择Edit-ClangFormat-File选项
6)选择你想要格式化的代码,然后Edit-ClangFormat-确认File为勾选状态-Format Selected Text
2.测试使用
用 xcode 插件管理器 Alcatraz 安装,通过终端运行命令 update_xcode_plugins –unsign, 重启 xcode 可以使用。
但第二次重启所有插件便无法使用。