IOS 开发规范文档

版权声明:本文为博主原创文章,未经博主允许不得转载。转载请注明转至Z.MJun的简书


1. 每一行的字数限制

  • 80个字数限制
  • xcode设置 屏幕左上角Xode->Perference->Text Editing->"Page guide at column: 80" 打上勾
  • 每一行的代码尽量不要超出80个字的长度,超出的回车排版, 方法名的冒号对齐

2. 命名规范

驼峰式命名

  • 类命名

    • 首字母大写,每个单词首字母大写
    • 尽量使用能够反映类功能的名词短语
    • eg: UserManage ,UserData
  • 特殊类命名

    • UIKit里的UI界面部分

    • 控件类型直接使用尾端的驼峰单词
      eg:
      UIView -> xxxView
      UViewController -> xxxViewController
      UIButton -> xxxButton
      UILabel -> xxxLabel
      UIImageView -> xxxImageView
      UITableView -> xxxTableView
      UITableViewCell -> xxxCell
      UIAlertView -> xxxAlertView
      UIScrollView -> xxxScrollView

      以下类名过长,取中间的单词作为尾端
      UIActivityIndicatorView -> xxxActivity
      UIPickerView -> xxxPicker
      UIProgressView -> xxxPorgress

  • 分类(类别)命名

    • 与类命名相同,此外需添加要扩展的类名"+"
      eg: NSString+Login UIView+XIB
  • 协议(委托)命名

    • 与类命名相同,此外需添加“Delegate”后缀
      eg: UserManager 对应 UserManagerDelegate
  • 方法命名

    • 首字母小写,之后每个单词首字母都大写
    • 方法名使用动词短语
    • 如果该方式对内部使用的在前面加 "_"
    • 如果该方法对外使用不需要加“_”
      eg:- (void) _loadData:(NSData *)data

    重点说明
    1.“-” 号后面有个空格
    2.“(void)” 右面有一个空格
    3.传递参数的类型如果是指针,类与*号之间有空格

  • 方法参数命名

    • 首字母小写,之后每个单词首字母都大写
    • 具有足够的说明性
    • 不需要添加类型前缀
    • eg: - (void) setUserData:(NSDictionary *)userInfo
  • 变量命名

    • 首字母小写,之后每个单词首字母都大写
    • 具有足够的说明性
    • 成员变量不需要添加“_m”前缀
    • 成员变量添加“_”前缀
      eg: NSMutableDictionary *_dataDic;
    • 如果该变量是属性不需要添加“_”
      eg: @property (nonatomic) NSDictionary *dataDic;
  • 常量

    • 常量(预定义,局部常量等)使用小写k开头的驼峰法
      eg:#define kUpdateUserInfoNote @"kUpdateUserInfoNote"
    • 枚举类型统一使用typedef NS_ENUM(类型, 名称)
    • 枚举的内容使用 名称小内容_
      eg:
      typedef NS_ENUM(NSInteger, Code) { Code_Success = 200, Code_Fail = 201, }
  • IBAction 方法

    • 如果是Button时间,方法名后缀使用Action,如果是内部使用,前面添加'_'
      eg:- (IBAction)_popAction:(UIButton *)sender;
  • 图片命名

    • 使用英文,全部小写,单词中间"_"隔开
    • 添加UI模块名作为前缀,避免冲突
    • 图片存放在 Images.xcassets
      eg: bar_title icon_coin
  • 注释

    • 在注释的地方使用 //即可
    • 文件下的方法区域分类,使用#pragma mark -,可以把在文件路径下的方法分类并标记
      eg:#pragma mark - Http
  • 必须使用大写命名,"_"隔开
    • eg:SCREEN_WIDTH_RIOT

3. 代码优化

  • 避免相同的代码段在多个地方出现
    相同的代码,必须归纳出来并且用一个类封装起来
  • 语句嵌套层次不得超过3层,超出的必须抽取出中间函数
    eg:for,while循环 if,do
  • 及时删除或注释掉无用的代码
  • 确定不使用的代码应该删除

4. 头文件.h 执行文件.m

  • .h文件

    • import "xxxx.h" 部分头文件时候,如果只是内部使用,请放在.m文件下,.h使用@class xxxx 声明该类即可
    • 文件下有声明代理,把@protocol代理放在@interface 上面
    • 代理方法必须包含该类名
      eg:
      @class ImageOperation;
      @protocol ImageOperationDelegate<NSObject>
      - (void) operation:(ImageOperation *)op didLoadImage:(UIImage *)image;
      @end
      @interface ImageOperation : NSOperation
      @end
  • .m文件

    • @implementation ViewController 上方使用 @interface ViewController() @end
    • 如果文件中使用过IBAction的方法,并且外部不能使用,统一放在这里,并且前面加"_"。
      eg: - (IBAction) _popAction:(UIButton *)sender;
    • 使用部分代理,并且代理不被外部使用,请把他们都放在.m的interface ()
      eg:@interface ViewController () <UITableViewDataSource,UITableViewDelegate>

5.代码整体规范,系统函数放上面,自定义函数放下面

如常见的viewcontroller

- (void)viewDidLoad{}
- (void)viewDidAppear:(BOOL)animated{}

然后跟着的是Delegate,DataSource
//如UICollectionViewDelegate,UICollectionViewDataSource
- (NSInteger)collectionView:(UICollectionView *)view numberOfItemsInSection:(NSInteger)section{}
- (UICollectionViewCell *)collectionView:(UICollectionView *)collectionView cellForItemAtIndexPath:(NSIndexPath *)indexPath{}
......

最后跟自己的方法
- (void) xxxXxxx{}
  • 中间使用#pragma mark-分割,如 Delegate,DataSource 和 自己的的方法

其他类如此类推

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,386评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,142评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,704评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,702评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,716评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,573评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,314评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,230评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,680评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,873评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,991评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,706评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,329评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,910评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,038评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,158评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,941评论 2 355

推荐阅读更多精彩内容