刘浩的技术博客

就当是做个笔记,顺便分享一些知识,更希望业界的交流

用工具规范OC代码样式

规范OC代码样式

在团队开发过程中,可能你team里面的每个成员都有自己不同的代码风格,其实代码风格到不是一定要很规范,但是一定要很统一,这样整体的代码在是视觉上就不会显得很混乱,而且互相阅读代码的时候也会很自然。这篇文章是来安装适当的工具强制team成员形成统一的代码样式。

安装Xcode插件用于格式化你的代码到相应的范式

这里这里有一个插件,安装完后你就可以在Xcode的菜单中找到响应的格式化命令了。安装可以选择在终端运行

    curl -SL https://raw.githubusercontent.com/benoitsan/
    BBUncrustifyPlugin-Xcode/master/install.sh | sh

自动下载安装。(也可以使用插件目录中提到的另外两种安装方法)

安装完成后,如果重启Xcode可以看到菜单Edit > Format Code中的以下命令:

  1. 使用Format Selected Files去格式化在项目导航中选定的文件。
  2. 使用Format Active File去格式化在编辑器中实际打开的文件。
  3. 使用Format Selected Lines去格式化选中的代码行(多行选中时支持的)。如果选中的行没有满选会自动扩展的整行,如果没有选中任何行,就会使用光标下的行作为格式化。
  4. 使用Edit Configuration在一个额外的编辑器去配置这个格式化程序。
  5. 使用BBUncrustifyPlugin Preferences去改变插件参数配置。

UncrustifyX可视化配置你的代码规范

你想要的代码规范是怎么样的,你可以参考这里去直接编辑文件设置你要的格式,你也可以使用UncrustifyX这个可视化工具配置,推荐后者,这样会有感官。你可以到这里下载最新版本安装。

git commit hooks(这里使用Git版本控制)

这里有已经写好的pre-commit-uncrustify(rename为pre-commit)canonicalize_filename.sh(一个定位路径输出的文件)可以下载,把这个两个文件copy到你的本地项目仓库的.git/hooks文件夹下面,值此就可以生效了,不过别忘了做一下配置,像如下的:

  1. 设置uncrustify的路径像我这里的的路径为/Applications/UncrustifyX.app/Contents/Resources/uncrustify.
  2. 设置uncrustify配置位置,我这里路径为$HOME/.uncrustify/uncrustify.cfg.

git receive hooks

commit可能还不能满足要求,我们为了统一代码规范,需要在git服务端检查,规范不符合我们团队的我们就拒绝push,所以需要在receive的时候也触发调用。这里这里有我自己参考资料改的一个pre-receive文件可以达到上述要求,你下载完成后把pre-receivecanonicalize_filename.sh一并copy到服务端你的项目仓库的hooks目录下面,至此就会生效了。