IOS编码安全规范.docx

移动端-IOS编码安全规范命名Bundle id命名：规则：采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名根据应用进行命名。类命名：类命采取驼峰命名规则，即首字母必须大写，如果为词组，则每个单词的首字母必须大写，类名只能使用名词或名词词组，力求类名简单，不允许出现冗余的单词。继承自UIView的类以View结尾。继承自ViewController的类以ViewController结尾。保存数据的实体以Model结尾。方法的命名：规则：方法名第一个单词是一个动词，其首字母小写，其后的所有单词首字母大写。如：public Void threadRun()类中常用方法命名：类的获取方法如果返回值为单个值，一般在头部加上单词“get”。如果返回值是数组或列表，要在头部加单词“find”如：public String getUserName() 、public listString findFriends()类的设置方法在被访问字段名的前面加上前缀 set如：public void setName（String name）类的布尔型判断方法一般要求方法名使用单词 is或has 做前缀如：isNetWorkConnected（）构造方法应该用递增的方式写。参数个数少的在前变量命名规则：第一个单词首字母必须小写，往后的单词需要符合驼峰命名规则，即第一个字母大写。变量名尽可能的使用名词或名词词组。同样要求简单易懂，不允许出现无意义的单词。如：String userName 避免使用全局变量，如果用到必须加前缀 ‘ Pub_’,同时需要在变量名体现其类型。成员变量命名与变量命名一样，在private字段前加上字母“m”。控件变量命名规则：一般的变量命名后加上控件名称IBOutlet UILabel *userNameLabel;常量命名：规则：必须全部大写，单词间用下划线隔开。如：MAP_KEY异常命名：规则：自定义异常首字母大写，以 Exception 为结尾。如：AppException资源命名：项目中所使用的所有资源命名必须以全部单词小写，单词间以下划线分割，加前缀区分。名称功能btn_xx_normal按钮正常情况下的效果btn_xx_press按钮点击下的效果bg_head背景图片使用bg_功能_说明def_search_cell默认图片使用def_功能_说明icon_more_help图标图片使用icon_功能_说明Seg_list_line具有分割特征的图片使用seg_功能_说明Sel_ok选择图标使用sel_功能_说明注释头文件注释：所有的源文件都应该在开头有一个注释，其中列出头文件的相关描述、作者、以及对应的版本信息。/*! @header 头文件名称 @abstract 关于这个源代码文件的一些基本描述 @author作者 @version 1.00 2012/01/20 Creation (此文档的版本信息：版本号+创建时间) */类注释每一个类都要包含如下格式的注释，以说明当前类的功能等。/*! @class 类名 @abstract 这里可以写关于这个类的一些描述。 */枚举注释每一个枚举都需要包含相对应的enum描述，以及每个枚举值对应的含义。/*! @enum 枚举名称 @abstract 关于这个enum的一些基本信息 @constant 各个对应值得含义，如： OKButton 对应的是OK按钮的Tag */协议注释协议需要注明是哪个类对应的protocol，以及自身的相关描述。/*! @protocol 协议名称 @abstract 这是哪个类的protocol @discussion 具体描述信息 */方法注释包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和对应的错误参照。/*! @method 方法名 @abstract该方法的一些简要描述 @discussion该方法的具体使用方式，需要注意的地方，如果你是设计一个抽象类或者一个共通类给给其他类继承的话，在这里需要具体描述一下怎样使用这个方法。 @param text参数列表 @param error 错误参照 @result 返回结果 */属性注释/*! @property 属性名称 @abstract 该Property的一些基本描述。 */类别注释/*! @category 类别名称 @abstract 哪个类的类别 */代码风格缩进规则：禁止使用tab进行缩进，缩进为4个空格.h文件空行可以使用空行的情况：文件说明与头文件包含(#import)之间类声明跟接口声明之间。头文件包含(#import)与@class之间@interface与@class之间头文件{}内，空1行开始写成员对象。头文件{}外，空1行开始