刚接触iOS那会对于代码的规范很有“清楚”的概念，不就代码整齐吗!

随着对开发项目的接触，对于那时的“清楚”感觉很大脸啊。开发中我们不仅是写好自己的代码也要和同事合理的交流，如在命名方面只有自己看的懂，那无非是种自私的表现（还怎么让同事看），如只是个人开发的项目，那很显然对自己的不负责。

meitu.jpg

    好了进入正题，现在我就分享下自己的对于代码规范的见解和一些前辈们的见解。

在Objective-C：


【1】 任意函数——长度不得超过50行。（其实很容易就超过50行，这就要考虑如何合理的抽取代码了。）

【2】任意行代码——不能超过80字符。（其实也很容易超过80字符，可以考虑多行显示，比如有多个参数时，可以每个参数放一行。）可以在Xcode中设置超过80个字符的提醒，选中“Page guide at column”.设置完之后就会在代码80个字符处有一条竖线。

1458286449568601.png【3】——声明类或方法时，注意空格的使用，参数过多时可换行保持对齐

- （instancetype）initWithCardCount:(NSUInteger)count
                          usingDeck:(Deck *)deck;

                                      调用方法时也是如此，参数都写在一行或换行冒号对齐

UIAlertView *alertview = [[UIAlertView alloc]initWithTitle:@"确认信息？"
                                                  message:@"确认提交数据吗？"
                                                 delegate:self
                                        cancelButtonTitle:@"取消"
                                        otherButtonTitles:@"确定",nil];

【4】命名规则——类名首字母大写，方法首字母小写，方法中的参数首字母小写，同时尽量让方法的命名读起来像一句话，能够传达出方法的意思，同时取值方法前不要加前缀“get”

- （void）chooseCardAtIndex:(NSUInteger)index;

变量名小写字母开头

int chosenButtonIndex = [self.cardButtons indexOfObject:sender];

常量以小写字母k开头，后续首字母大写

static const NSString* kLNRouteServiceString = @"http://www.@@@@@.com;

【5】关于注释——注释很重要，但除了开头的版权声明，尽可能把代码写的如同文档一样，让别人直接看代码就知道意思，写代码时别担心名字太长，相信Xcode的提示功能。

【6】实例变量——应该在实现文件.m中声明或以@property形式在.h文件中声明，一定要直接在.h文件声明，加上@priavte，另外，使用@private、@public，前面需要一个缩进空格。

【7】尽可能保证—— .h文件的简洁性，可以不公开的API就不要公开了，写在实现文件中即可。

【8】Xcode——支持Objective-C/C/C++混编，所以引用头文件时：#import Ojbective-C/Objective-C++头文件（Objective-C++是Objective-C与C++混编的文件），#include C/C++头文件。

【9】写delegate——的时候类型应该为weak弱引用，以避免循环引用，当delegate对象不存在后，我们写的delegate也就没有存在意义了自然是需要销毁的，weak与strong可以参考上一篇文章介绍。

【10】实例变量——声明时变量名前面加下划线“_”，局部变量不用加

【11】使用Block时——内容四个空格缩进，“^”后带有参数时，参数与“{”之间有一个空格缩进

【12】尽量减少——在代码中直接使用数字常量，而使用宏定义等方式。如：MAX_NUMBER_PHONE替代8等等。这样我们搜索也比较方便。

【13】建议使用——“#pragma mark”，方便阅读代码

【14】尽量减少——代码中的重复计算，比如代码中多处要使用屏幕宽度，然后计算：[[UIScreenmainScreen] bounds].size.width ,很多次，闲得很繁琐，代码也冗长。不如直接宏定义：

#define SCREEN_WIDTH ([[UIScreen mainScreen] bounds].size.width)

【15】合理使用——约定俗成的缩略词：

  • alloc:分配；

  • alt：轮流，交替；

  • app:应用程序；

  • calc：计算；

  • dealloc：销毁、析构；

  • func：函数、方法；

  • horiz：水平的；

  • info：信息；

  • init：初始化；

  • max：最大的；

  • min：最小的；

  • msg：消息；

  • nib：Interface Builder；

  • rect：矩形；

  • temp：暂时的；

  • vert：垂直的；

【16】宏定义——全部字母大写。

【17】对传入参数的保护或者说是否为空的判断，尽量不要使用if(!obj),而使用NSAssert断言来处理。NSAssert是系统定义的宏。

NSAssert(myName != nil, @"myName参数为空")                    

  • 如果条件判断为真，则程序继续执行。

  • 如果判断条件为假，则抛出异常，异常内容为后面定义的字符串。

【18】提下版本控制——务必去学会SVN或者Git，就算你是独立开发，也要学会控制自己的代码，当然，你要经常备份你的代码

主要参考规范：

 

1. Google Objective-C Style Guide

 

2. Coding Guidelines for Cocoa



  

0
0