澳门新葡亰官网object- c 编码规范及指导

澳门新葡亰官网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

  • 注释
    注的位置应跟吃描述的代码相邻,可以在代码的头或右,不可在下方。
    限写代码边注释,修改代码同时修改相应的笺注,以管教注释与代码的一致性。不再实用之诠释要刨除。
    注应当规范、易懂,防止注释有二义性。错误的注释不但无用反而损害。
    当代码比较长,特别是来差不多双重嵌套时,应当于部分截的毕处加注释,便于阅读。对于工作逻辑,常用的枚举数据,或者代码对应之参数定要是发出认证,如

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