标签：软件工程   attribute   int   标准   无法   pre   family   button   set   

 1. 总体指导原则

说明：这是软件开发的基本要点，软件的生命周期贯穿产品的开发、测试、生产、用户使用、版本升级和后期维护等长期过程，只有易读、易维护的软件代码才具有生命力，所以提倡写代码之前多思考，特别是逻辑复杂或者技术难点较高的地方，个人思考不清楚的，可以和团队成员进行沟通。

说明：简单是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否则会降低程序的可读性。

说明：编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，最后才考虑程序的效率和资源占用。

说明：不可以测试的代码是无法保障质量的，开发人员要牢记这一点来设计、编码。实现设计功能的同时，要提供可以测试、验证的方法。

说明：方法是一个处理单元，是有特定功能的，所以应该很好地规划方法，不能是所有东西都放在一个方法里实现，也不能把所有东西都放在一个类里面实现(比如说VC)。

2.控制器规范

说明：这是因为采用属性的方式，如果该控制器调用地方较多，每个地方的参数不一样，会造成调用方属性赋值的困惑。

• 头文件

文件头

#import （依次为标准库头文件、非标准库头文件）

宏定义

全局数据类型

类定义

•  实现文件

文件头

#import （依次为标准库头文件、非标准库头文件） 

文件内部使用的宏

文件内部使用的数据类型

全局变量

本地变量（即静态全局变量）

类的实现

#pragma mark - LifeCycle

#pragma mark - Private Method

#pragma mark -- UI

#pragma mark -- 数据加载和解析

#pragma mark - Event

#pragma mark - Delegate

#pragma mark -- UITableViewDataSource

#pragma mark -- UITableViewDelegate

#pragma mark - Getter/Setter

3.命名规范

说明：

1. 小驼峰法：除第一个单词之外，其他单词首字母大写；
2. 大驼峰法：把第一个单词的首字母也大写。

关于类型，主要有如下几类：

说明：比如定义一个姓名的标签，描述为name，类型为Label，命名为nameLabel。

关于类型缩写，主要有如下两大类：

一、Foundation类型

 二、UIKit类型

1. 方法的名称应全部使用有意义的单词组成，读起来像一句完整的话，能让人从名字就能知道方法的作用；
2. set方法前需要添加set，get方法前不需要添加get；
3. 常用的方法命名应该使用约定的动词，如initWith、insert、remove、replace等；
4. init方法应该遵循Apple命名规则，返回类型使用 instancetype而不是id；
5. 方法签名中，应该在方法类型(-/+ 符号)之后有一个空格。在方法各个段之间应该也有一个空格。

typedef NS_OPTIONS(NSInteger, MASAttribute) {

    MASAttributeLeft = 1 << NSLayoutAttributeLeft,

    MASAttributeRight = 1 << NSLayoutAttributeRight

};

说明：

1. 模块可分为公用模块和私有模块，可自定义模块的缩写，比如说公用模块的导航栏，可以定义缩写为nav；
2. 功能根据具体的用途划分，比如说返回按钮，功能可定位为back；
3. 类型主要有几类：如背景(bg)，按钮(btn)等。

综上所述，如果是导航栏的返回按钮，可命名为nav_back_btn@2x.png。

4.注释

【规则4-1】注释建议统一使用VVDocument插件。

iOS编码规范(简版)

标签：软件工程   attribute   int   标准   无法   pre   family   button   set   

原文地址：http://www.cnblogs.com/LeeGof/p/6230092.html