菜单

生物学编码规范与指引

2018年12月25日 - 生物学

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地图