ios开发编码及命名规范.doc

IOS开发编码及命名规范
目录
1、目的 3
2、适用范围 3
3、编码规范 3
、文件 3
、注释 3
、编码排版格式 4
、命名规范 6
、保留字 6
、方法 7
、变量 7
、常量 8
、类 8
、修改规范 9
、新增代码行 9
、删除代码行 9
、修改代码行 9
1、目的
统一规范XCode编辑环境下Objective-C的编码风格和标准
2、适用范围
适用于所有用Objective-C语言开发的项目。
3、编码规范
、文件
1) 项目文件都是使用因文命名。
2) 公共文件统一命名为’ ’。任何文件的命名尽量不要以中文命名。
3) 对于文件的目录要按如下结构创建:
-。
-所有的三方库在单独的组(Group)中,如ThirdPartLibrary。
-所有的分类跟封装放在单独的组中,如Common。
、注释
1) 注释可以采用’/* */ ’和’// ’两种注释符号,涉及到多行注释时,尽量使用
’/* */ ’。
2) 对于一行代码的注释可放在前一行及本行上,不允许放在下一行,更不允许在一行语句的中间加入注释。
3) 单元文件的文件头注释说明应按如下格式:
//
// 文件名
// 工程名
//
// Created by 创建者 on 日期.
// Copyright 2010 xxx有限公司. All rights reserved.
//
// 系统名称:
// 功能描述:
// 修改记录:(仅记录功能修改)
// 张三 2012-02-02 创建该单元
// 小明 2010-03-02 增加本地点单功能。
、编码排版格式
1) 代码的缩进应使用空格(SPACE),不能使用制表符(TAB),并且缩进以2个字符为单位。
2) 中括弧的每一个括弧在源程序中要单独占一行。
例如
//不正确用法
for (int i = 0; i < 10 ; i++){
}
//正确用法
for (int i = 0; i < 10; i++)
{
……
}
3) 空格的使用
a) 关键字与其后的表达式之间要有空格,如:
if (expr)
或
for (expr)
b) 单目操作符不应与它们的操作数分开(如’!’和’^’等)。
c) 除’, ’外,其它双目操作符应与它们的操作数用空格隔开。
例如
i=i+1; //错误的写法,操作符两端没有空格
i = i + 1; //正确的写法,
if(a>b) //错误的写法,逻辑判断符号两端没有空格
if(a > b) //正确的写法
d) .h中协议<>前面有一个空格。
e) .h中成员声明时,类型与变量之间有至少1个空格。*号靠近变量,不靠近类型。
f) ***@property后留1个空格,()里面,逗号紧跟前一变量,与后一变量之间留1个空格。()外面,先留1个空格,再声明属性。
g) 方法的+,-后面与()之间留1个空