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

在h文件中引用其他类用,一个包可以包含模块和其他包

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程序其实是休专业之。
我们事先定义的模块名字是:

lovebet体育 1

创建Python文件.png

现今应当变更化:

lovebet体育 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")

会报错:

lovebet体育 3

IDE缩进错误.png

粗犷运行,也会报错:

lovebet体育 4

运行错误.png

除此以外,空行也是Python程序的均等有。
函数之间或类的方式中因此空行分隔,表示同样段落新的代码的开头。类以及函数入口中也用一行空行分隔,以突出函数入口的始。

空行与代码缩进不同,空行并无是要要遵从的Python语法。书写时莫栽入空行,Python解释器运行为不见面错。但是空行的用意在于分隔两段不同作用或含义的代码,便于日后代码的掩护或重构。
如若非投入空行,不会见报错,不过会出警告,比如:

lovebet体育 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工具会报警告,提示

lovebet体育 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
{

}