object- c 编码规范和指导。Python学习日记-基础语法1

object-c 编码规范与指导

本章目录

  • Part One:标识符
  • Part Two:Python关键字
  • Part Three:注释
  • Part Four:行与缩进, 空行
  • Part Five:多行语句

查阅了查资料,Python是故模块(module)和 包(package)来集团大型文件之。
模块 是一个出于 变量、函数、类
等基本因素结合的成效单元,设计良好的模块通常是高内聚、低耦合、可复用、易维护的。而一个模块内部是足以分包一个或基本上个像样的。
包 是治本模块的器皿,它有
可嵌套性:一个管教得分包模块和其他保险。从文本系统的眼光来拘禁,包就是是目录,模块就是文本(之前写第一个Python程序里创建的py文件)。

文档版本

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

标识符

标记符其实也便是命名规则,在Python里面要使按部就班以下标准:

  • 首先只字符必须是配母表中字母或下划线’_’;
  • 标识符的别的片段由字母、数字和下划线组成;
  • 标识符对大小写敏感;
  • 莫能够下Python关键字当标识符名称。

稍许看下,跟Java的命名规则平等,不过为发出几乎碰是要是尽量避免的条条框框:

  • 单字符名称, 除了计数器和迭代器;
  • 包/模块名受之并字符(-);
  • 对产划线开头并最终的称(Python保留, 例如init)。

再者也,由于组织结构的莫平等(Java是承保以及好像,而Python是保险和模块),所以当命名约定上啊发出一部分不比:

  • 所谓“内部(Internal)”表示无非模块内可用,或者,在类内是保护要个体的;
  • 从而就下划线(_)开头表示模块变量或函数是protected的(使用import *
    from时无会见蕴藏);
  • 于是双产划线(__)开头的实例变量或方式表示类内私有;
  • 用有关的类及五星级函数放在同一个模块里。不像Java,
    没必要限制一个近似一个模块;
  • 本着类名使用好写字母开头的单词(如CapWords,
    驼峰法),但是模块名应当据此小写加下划线的措施(如lower_with_under.py)。
    尽管就起过多存的模块使用类似于CapWords.py这样的命名,但今天就不鼓励这样做,因为只要模块名正要和类名一致,这会吃人口劳。

这些足以总结为Python之父Guido推荐的正规化:

Type(模块) Public(公有的) Internal(内部的)
Modules(模块) lower_with_under _lower_with_under
Packages(包) lower_with_under
Classes(类) CapWords _CapWords
Exceptions(异常) CapWords
Functions(函数) lower_with_under() _lower_with_under()
Global/Class Constants(常量) CAPS_WITH_UNDER _CAPS_WITH_UNDER
Global/Class Variables(类变量,即静态变量) lower_with_under _lower_with_under
Instance Variables(实例变量,即成员变量) lower_with_under _lower_with_under(protected) or __lower_with_under (private)
Method Names(方法) lower_with_under() _lower_with_under() (protected) or __lower_with_under() (private)
Function/Method Parameters(参数) lower_with_under
Local Variables(局部变量) lower_with_under

综合,我们在前面写的率先单python程序其实是休标准之。
咱俩前面定义的模块名字是:

图片 1

创建Python文件.png

今天应该改变成为:

图片 2

修改模块名.png

概述

对其余工程项目来说,统一之施工规范都是确保工程质量的主要元素。堪称当今生人无比抽象、最复杂的工—软件工程,自然更不克例外。高格调、易维护的软件开发离不开清严格的编码规范。本文档详细描述object-C软件开发过程中的编码规范。本标准为适用于具有以文档中起的源码。

Python关键字

Python中,不能够采取要字当标识符。Python的官API库里面提供了一个keyword模板,可以出口当前版的有重大字:

import keyword
var = keyword.kwlist
print(var)

时总计发生33单重大字:

['False', 'None', 'True', 'and', 'as', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except', 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is', 'lambda', 'nonlocal', 'not', 'or', 'pass', 'raise', 'return', 'try', 'while', 'with', 'yield']

文本结构

怀有iphone的源文件均要包含一个业内的求证,说明包含了拖欠公文的号、功能概述、作者、版权和版本历史信息等情节。文件头和函数的证实的格式为:

注释

注解可以自及一个备注的用意,团队通力合作的时光,个人编写的代码经常会面给多丁调用,为了吃人家会还便于掌握代码的坦途,使用注释是很管用之。
Python中的注解只要出3种植:单行注释,多行注释以及编码注释。

  1. 单行注释
    单行注释是坐#开头,#号后的始末编译器会忽视掉。比如:

# 这是一条输出语句
print('Hello World')  # 后面的内容会被忽略掉

得看来,#声泪俱下后要加个空格,要无见面起警示。

  1. 差不多行注释
    大多实行注释可以据此几近只# 标注

# 这是一条输出语句
# 第二行注释
print('Hello World')

啊足以为此”’ ”’或者””” “””包裹

# 这是一条输出语句
# 第二行注释

"""
多行注释
多行注释
"""

'''
多行注释
多行注释
'''
print('Hello World')

以为,多尽注释的标示也可是用以多履字符串,顺道查看了瞬间官的源码,发现用#跟”””的于多。

  1. 编码注释
    编码注释在Python2.x就此底较多,因为在旧版里,文件默认使用ASKII码保存文件。而于Python3.x里,文件默认使用unicode编码,这样的话就可以辨认中文了,不见面吃中文产生乱码。
    编码注释最专业的格式是:

# -*- coding: <encoding name> -*-

例如:

# -*- coding: gbk -*-

这般形容的补益是可支撑多编辑器,移植性好。
另外,急需留意的是须以编码注释放在第一履行要第二执行
尚起其他比较简单的写法,比如官方源码使用的是:

# encoding: utf-8

尚足以是:

# coding=<encoding name>  

# vim: set fileencoding=<encoding name> :

总的说来,所有的科班是按照一个正则表达式给来之:

\%^.*\n.∗\?#.*coding[:=]\s*[0-9A-Za-z-_.]\+.*$ 

个中的意就是是必包含#,且#声泪俱下前未克产生字符换行等其余字符,字符串中要包含coding后面可以同:或者=接下来就编码名称。

1.文书头说明

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

实施及缩进,空行

Python是运缩进来代表代码块的,不欲{}。
缩进的空格数是可变的,但是和一个代码块的语句必须包含相同之缩进空格数,所以最好是故4只空格来决定缩进,例如:

if True:
    print("True")
else:
    print("False")

设而缩进未等同为,IDE工具会自动唤醒有左,比如

if True:
    print("True")
    print("Same")
else:
    print("False")
  print("Blabla")

会报错:

图片 3

IDE缩进错误.png

野运行,也会见报错:

图片 4

运转错误.png

另外,空行也是Python程序的均等有些。
函数之间或类的计之间用空行分隔,表示无异截新的代码的起来。类及函数入口中也就此一行空行分隔,以突出函数入口的开。

空行与代码缩进不同,空行并无是要使遵循的Python语法。书写时无栽入空行,Python解释器运行为无见面拧。但是空行的打算在于分隔两段不同功能要含义的代码,便于日后代码的掩护或重构。
一旦无参加空行,不会见报错,不过会生警示,比如:

图片 5

空行提示.png

2.计求证

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

多行语句

  1. 分行
    Python通常是用一行来形容了一久语句,但是要是告诉句过长,可以据此\来实现多履,例如:

item_one = 1
item_two = 2
item_three = 3
total = item_one + \
        item_two + \
        item_three
print(total)

行使Pycharm的话,我们特需要在怀念如果分行的地方敲回车即可。
在 [], {}, 或 () 中之大半行语句,不需要使用反斜杠(),例如:

total = ['1', '2', '3'
        '4', '5']

总之,使用IDE工具以来,语句的支行并不需要太过在意。

  1. 一行
    前面说的是单排语句分多行显示,那么一旦多行语句想写到一行也,在差不多修告句间使用分好分割即可,例如:

import sys; x = 'runoob'; sys.stdout.write(x + '\n')

尽管如此语法上如此写没错,不过IDE工具会报警告,提示

图片 6

一行警告.png

证这种写法并无吃提倡。

  1. 代码组
    于眼前的缩进部分,有关系了代码块是概念,不过那时候关注的关键是缩进。那么,什么是代码组?

缩进相同的一组语句构成一个代码块,我们称之代码组。
像if、while、def和class这样的复合语句,首行以关键字开始,以冒号( : )结束,该行之后的一行或多行代码构成代码组。
我们将首行及后面的代码组称为一个子句(clause)。

例如:

a = 3
if a == 1:
    print('a')
    print('A')
elif a == 2:
    print('b')
    print('B')
else:
    print('c')

同时细研究了下Python风格规范,貌似还有好多,回头有空再变更了,具体参考Google出品的Python风格指南

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