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

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