菜单

object- c 编码规范与指导

2018年9月19日 - bway883必威官网

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)这个类库管理工具

取名规则

如想要立竿见影的军事管制一个有些复杂一点之网,针对中事物的同等效统一、带层次结构、清晰明了的命名规则就是是不可或缺而且好好用的工具。
外向于生物学、化学、军队、监狱、黑社会、恐怖组织等各个领域内之恢宏有识先辈们都曾经无数次地因为实际行动证明了上述公理的正确性。除了上帝(设它可以转移世间万物之秩序)以外,相信没有人起实力对它不屑一顾。
当软件开发这等同可观抽象而且十分复杂的倒着,命名规则的基本点再度展示更为突出。一效定义美而完全的、在一切项目蒙联合用的命名规范将大大升级源代码的可读性和软件的可维护性。
以引入细节之前,先证一下命名规范的完好规范:

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. 代码风格

代码风格以及版式代码风格的根本怎么强调都非过分。一段稍长一些底无格式代码基本上就不行读之。
先来拘禁一下立刻点的一体化标准:

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

以上风格是预约风格,而下面风格则无提倡。

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

“{ }” 之内的代码块当 “{”
右边一个制表符(4个半竞赛空格符,直接以键盘上的Tab键来展开控制)处错误对同步。

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

}

相关文章

标签:,

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图