object- c 编码规范与指导

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

  • 注释
    诠释的职务应与为描述的代码相邻,可以在代码的顶端或右,不可在下方。
    限写代码边注释,修改代码同时修改相应的注解,以保险注释与代码的一致性。不再灵光之诠释要去除。
    注解应当规范、易懂,防止注释有二义性。错误的诠释不但无用反而损害。
    当代码比较丰富,特别是产生差不多还嵌套时,应当以有段子的了断处加注释,便于阅读。对于365bet体育在线客户端政工逻辑,常用的枚举数据,或者代码对应的参数毫无疑问要是发证实,如

/**
 *  设置类型
 *
 *  @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地图