编码规范与引导

object-c 编码规范与指导

文档版本

版本号 修改时间 修改内容 修改人
1.0 2011-04-12 创建 贺发虎
1.1 2015-01-21 修改 谢躜

概述

对于其它工程项目来说,统一的施工标准都是保险工程质地的显要因素。堪称当今生人最抽象、最复杂的工程—软件工程,自然更为不可能例外。高格调、易维护的软件开发离不开清晰严峻的编码规范。本文档详细描述object-C软件开发过程中的编码规范。本专业也适用于具有在文档中出现的源码。

文件结构

具备iphone的源文件均必须含有一个正经的认证,表明包含了该文件的名称、效用概述、作者、版权和本子历史音信等情节。文件头和函数的验证的格式为:

1.文书头表明

/*fileName
======================================================================
模块名 :<模块名称>
文件名 :<文件名>
实现功能:<描述该文件实现的主要功能> 
作者  :<作者部门和姓名>
版本  :<当前版本号>
创建日期:
备注  :<其它说明>
修改日期:<日期格式:yyyy-mm-dd>
修改人 :<修改人>
修改内容:<修改内容>
======================================================================
fileName*/

2.格局求证

/**
 *  <#Description#>
 *
 *  @param task    <#task description#>
 *  @param arrange <#arrange description#>
 *
 *  @created by 谢躜 on 2015-01-21 09:30:19
 */

3.头文件的引用表达

在h文件中引用其他类用@class fileName
在m文件中援引其他类都用#import “fileName.h

4.文本的团体结构

文档结构 .png

参考 coding ios 客户端源码规范

    ├── Coding_iOS
    │   ├── Models:数据类
    │   ├── Views:视图类
    │   │   ├── CCell:所有的CollectionViewCell都在这里
    │   │   ├── Cell:所有的TableViewCell都在这里
    │   │   └── XXX:ListView(项目、动态、任务、讨论、文档、代码)和InputView(用于聊天和评论的输入框)
    │   ├── Controllers:控制器,对应app中的各个页面
    │   │   ├── Login:登录页面
    │   │   ├── RootControllers:登录后的根页面
    │   │   ├── MeSetting:设置信息页面
    │   │   └── XXX:其它页面
    │   ├── Images:app中用到的所有的图片都在这里
    │   ├── Resources:资源文件
    │   ├── Util:一些常用控件和Category、Manager之类
    │   │   ├── Common
    │   │   ├── Manager
    │   │   ├── OC_Category
    │   │   └── ObjcRuntime
    │   └── Vendor:用到的一些第三方类库,一般都有改动
    │       ├── AFNetworking
    │       ├── AGEmojiKeyboard
    │       ├── ASProgressPopUpView
    │       ├── ActionSheetPicker
    │       ├── FontAwesome+iOS
    │       ├── MJPhotoBrowser
    │       ├── MLEmojiLabel
    │       ├── NSDate+Helper
    │       ├── NSStringEmojize
    │       ├── PPiAwesomeButton
    │       ├── QBImagePickerController
    │       ├── RDVTabBarController
    │       ├── SMPageControl
    │       ├── SVPullToRefresh
    │       ├── SWTableViewCell
    │       ├── UMENG
    │       ├── UMessage_Sdk_1.1.0
    │       ├── XGPush
    │       ├── XTSegmentControl
    │       └── iCarousel
    └── Pods:项目使用了[CocoaPods](http://code4app.com/article/cocoapods-install-usage)这个类库管理工具

命名规则

若果想要有效的军事管制一个略带复杂一点的系统,针对内部事物的一套统一、带层次结构、清晰明了的命名规则就是少不了而且十分好用的工具。
外向在生物学、化学、军队、监狱、黑社会、恐怖协会等各种领域内的大方有识先辈们都早已无数次地以实际行动表明了上述公理的科学。除了上帝(设它能够转移世间万物的秩序)以外,相信没人有实力对它不屑一顾。
在软件开发这一可观抽象而且分外复杂的移位中,命名规则的重中之重更显得愈加卓绝。一套定义卓绝并且完全的、在全体项目中联合采取的命名规范将大大升级源代码的可读性和软件的可维护性。
在引入细节从前,先表明一下命名规范的完好规范:

  • 同一性:
    在编辑一个子模块或派生类的时候,要按部就班其基类或全部模块的命名风格,保持命名风格在方方面面模块中的同一性。
  • 标识符组成:
    标识符采取英文单词或其重组,应当直观且可以拼读,可望文知意,用词应当规范。
  • 最小化长度和最大化音讯量原则:
    在维系一个标识符意思明确的同时,应当尽可能缩小其尺寸。
  • 避免过度相似:
    无须出现仅靠大小写区分的一般的标识符,例如iIfunctionFunction等等。
  • 防止在不同级另外功能域中重名:
    次第中永不现身名字完全相同的部分变量和全局变量,固然双方的功用域不同而不会暴发语法错误,但容易使人误会。
  • 不错命名具有互斥意义的标识符:
    用科学的反义词组命名具有互斥意义的标识符,如: minValueInteger
    maxValueIntegergetName()setName()

5. h,m,nib文件名命名

除了特别类等个别情形(不愿意被用户作为一个平日的、正常的类之情形)外,iphone的h,m,nib文件名命名应该遵从以下规则:

(1) h,m,nib文件名命名的名号都要以大写字母开首;

(2)
倘诺是相似的视图控制器,则后边加上ViewController,即h,m,nib文本名的称谓仿效分别为:

***ViewController.h
***ViewController.m
***ViewController.xib

(3)若果是自定义的视图类,则前面加上对应的品类,

UITableViewCell 简写为 Cell,UICollectionViewCell 简写为CCell

h,m,nib文件名的称呼仿效分别为:

***View.h、
***View.m、
***View.xib;

***Cell.h、
***Cell.m、
***Cell.xib;

***CCell.h、
***CCell.m、
***CCell.xib;

6. 变量

(1)具备变量名命名的名称都要以小写字母起始。

(2)类中定义变量名称:其利害攸关格式为***+对象类所在的名称,如给UITextFiled命名,则要写成***TextField、如valueTextFiledtitleTextField等,相应的UILabel的命名有valueLabeltitleLabel等,UITableView则要写成valueTableView等。其规则也一致适用于NSArray、NSMutableDictonary等有着品种;
除此以外,假若当前变量是友善类中动用,则要在后头加上下划线,如valueArray_等,而在性质中定义时用valueArray。

(3)全局变量全体以单词_global开班,以序列结尾,如_global***TextField_global***String等。

(4)分子变量。在变量前边加上下划线_

   UIButon * _cancelButton;

(5)其间NSMutaleArray、NSMutableDictonary与NSArray、NSDictonary的末尾相同,分别为Array及Dict,不做区分。

7. 方法

(1)具备办法名命名的名号都要以小写字母开端,要求语义完整清楚,不要乱用简写。

(2) 在ViewController中,一个控件可能有多少个事件
假使是事件的名号,则要先以对象名称加上对象的轩然大波,如

UIButton *nameButton;

#program mark - Event
//默认情况下 EventTouchUpInside 我们简写成 Pressed
- (IBAction) nameButtonPressed:(id)sender;
//EventTouchDown
- (IBAction) nameButtonTouchDown:(id)sender;

(3) Action。
如果是在一个视图类中,一个控件的风波相对于那一个视图类来说只是视图类的一个事件,则不需要以控件对像名称加上对像事件命名。
而是遵照视图类来命名。

@interface AbstractActionSheetPicker : NSObject
@end


UIBarButtonItem *sysDoneButton = [self createButtonWithType:UIBarButtonSystemItemDone target:self
                                                             action:@selector(actionPickerDone:)];


UIBarButtonItem *sysCancelButton = [self createButtonWithType:UIBarButtonSystemItemCancel target:self
                                                               action:@selector(actionPickerCancel:)];


- (IBAction)actionPickerDone:(id)sender
{

}

- (IBAction)actionPickerCancel:(id)sender
{

}

8. 宏

宏全部用小写,并且用必要的下划线分开,如

#define NAME_VALUE  @"dddd"
#define MAXSIZE     30

9. 常量

常量用字母 k 先导, 如

static const NSUInteger kUsernameRow = 0;

10. 代码风格

化学答案,代码风格与版式代码风格的首要怎么强调都可是分。一段稍长一些的无格式代码基本上就是不行读的。
先来看一下这地点的一体化标准:

  • 空行的应用
    空行起着分隔程序段落的意义。空行体面(但是多也只是少)将使程序的布局进一步显然。空行不会浪费内存,虽然打印带有空行的程序是会多消耗一些纸张,不过值得。所以不用舍不得用空行。
    这里不做规定,视自己的作风而定
  • 言辞与代码行
    一行代码只做一件工作,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且有利于于写注释。
    “if”、“for”、“while”、“try”、“catch”等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加
    “{ }” 。这样可以防范书写和改动代码时出现失误。
  • 缩进和对齐
    先后的分界符 “{” 和 “}” 的格式如下所示:

while(1){
    //statement
    for(int i=0;i<=n;i++){
        //statement
    }
}

如上风格是预约风格,而下面风格则不提倡。

while(1)
{
    //statement
    for(int i=0;i<=n;i++)
    {
        //statement
    }
}

“{ }” 之内的代码块在 “{”
左侧一个制表符(4个半角空格符,直接按键盘上的Tab键来进展控制)处左对齐。

  • 最大尺寸
    代码行最大尺寸宜控制在80个字符以内。代码行不要过长,否则眼睛看不东山再起,也不便于打印。但是此规则可以视情状适当放松。

  • 空格的行使
    重大字之后要留空格。象NSInteger等关键字之后至少要留一个空格;
    其他的不做要求,如for语句里面的几条语句、&&、||等。

  • 修饰符的地方
    为便于精晓,应当将修饰符 “*” 和 “&”
    紧靠变量,例如NSString *testStringNSArray *testArray

  • 注释
    注解的职务应与被描述的代码相邻,能够置身代码的顶端或右手,不可放在下方。
    边写代码边注释,修改代码同时修改相应的注释,以担保注释与代码的一致性。不再灵光的注明要去除。
    诠释应当规范、易懂,防止注释有二义性。错误的诠释不但无用反而损害。
    当代码相比较长,特别是有多重嵌套时,应当在有些段子的终结处加注释,便于阅读。对于事务逻辑,常用的枚举数据,或者代码对应的参数必然要有证实,如

/**
 *  设置类型
 *
 *  @param type  类型 0 公有,1 私有
 *
 *  @created by 谢躜 on 2015-01-21 18:47:24
 */
- (void)setType:(NSInteger)type
{
    if(0 == type){
        //当类型为公有的时候
        ...
    }else if (1 == type){
        //当类型为私有的时候
        ...
    }
}

11. h文件协会

类 interface h文件中分头依次列出属性方法

#import <UIKit/UIKit.h>

@interface DateilViewController : UIViewController
{
    //变量
    NSString *_dataString;
}


//属性
@property (nonatomic, strong) NSDictionary *supplyDateilDict;
@property (nonatomic, strong) NSMutableArray *supplyArray;

//方法
- (void)handleData;
- (void)createView;


@end

协议 protocol ,依次列出 @required,@optional

@protocol UITableViewDataSource<NSObject>

@required

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section;

// Row display. Implementers should *always* try to reuse cells by setting each cell's reuseIdentifier and querying for available reusable cells with dequeueReusableCellWithIdentifier:
// Cell gets various attributes set automatically based on table (separators) and data source (accessory views, editing controls)

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath;

@optional

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView;              // Default is 1 if not implemented

- (NSString *)tableView:(UITableView *)tableView titleForHeaderInSection:(NSInteger)section;    // fixed font style. use custom view (UILabel) if you want something different
- (NSString *)tableView:(UITableView *)tableView titleForFooterInSection:(NSInteger)section;

// Editing

// Individual rows can opt out of having the -editing property set for them. If not implemented, all rows are assumed to be editable.
- (BOOL)tableView:(UITableView *)tableView canEditRowAtIndexPath:(NSIndexPath *)indexPath;

// Moving/reordering

// Allows the reorder accessory view to optionally be shown for a particular row. By default, the reorder control will be shown only if the datasource implements -tableView:moveRowAtIndexPath:toIndexPath:
- (BOOL)tableView:(UITableView *)tableView canMoveRowAtIndexPath:(NSIndexPath *)indexPath;

// Index

- (NSArray *)sectionIndexTitlesForTableView:(UITableView *)tableView;                                                    // return list of section titles to display in section index view (e.g. "ABCD...Z#")
- (NSInteger)tableView:(UITableView *)tableView sectionForSectionIndexTitle:(NSString *)title atIndex:(NSInteger)index;  // tell table which section corresponds to section title/index (e.g. "B",1))

// Data manipulation - insert and delete support

// After a row has the minus or plus button invoked (based on the UITableViewCellEditingStyle for the cell), the dataSource must commit the change
// Not called for edit actions using UITableViewRowAction - the action's handler will be invoked instead
- (void)tableView:(UITableView *)tableView commitEditingStyle:(UITableViewCellEditingStyle)editingStyle forRowAtIndexPath:(NSIndexPath *)indexPath;

// Data manipulation - reorder / moving support

- (void)tableView:(UITableView *)tableView moveRowAtIndexPath:(NSIndexPath *)sourceIndexPath toIndexPath:(NSIndexPath *)destinationIndexPath;

@end

12. m文件社团

ViewController

/*Class 的生命周期
* Class 生命周期回调方法放在最前面
*/
#pragma mark - Lifecircle

- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
{  
}

- (void)viewDidLoad
{  
}

- (void)viewWillAppear:(BOOL)animated
{
}

- (void)viewDidDisappear:(BOOL)animated
{
}

- (void)didReceiveMemoryWarning
{
}

- (void)dealloc
{
}

/* 所有的控件事件放在生命周期后面
* 包括 Event ,Action,Notifation
* 如果是相近的方法用program mark 分类。排在一起。 
*/
#pragma mark - Event
- (void)backAction
{
}

- (void)selectTabbarButton:(UIButton *)sender
{
}

+ (void)reachabilityChanged:(NSNotification *)note
{
}

#pragma mark KeyBoardNotify
- (void)keyboardWillChange:(NSNotification *)note
{
}


- (void)keyboardShowNotify:(NSNotification *)note
{

}
//键盘隐藏调整界面
- (void)keyboardHideNotify:(NSNotification *)note
{

}

/*其它方法分为两部分, 
* 第一部分是数据模型操作相关的方法
* 第二部分为视图,控件相关操作 
*/
#pragma mark - Fouction

#pragma mark - HandleModal
- (void)getSupplyDateilData 
{
}

// 时间转换
- (NSString *)showTimeWithValue:(NSTimeInterval)time 
{   
}



//添加一个安排
- (void)addArrange
{
}


#pragma mark  HandleView
- (void)creatDateilView
{

}
// 显示土地信息
- (void)creatDateilInformationView
{

}

- (void)createAdvertisementView 
{ 
}

/*
* 其它协议,委托,数据源方法没有固定顺序,用到了就加到后面
*/


#pragma mark -UITableViewDataSource
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
}

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView
{

}

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
  }


#pragma mark -UITableViewDelegate
- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath {

}

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{

}

admin

网站地图xml地图