IOS编码安全规范

移动端-IOS编码安全规范命名Bundleid命名：规则：采用反域名命名规则，所有使用小写字母。一级包名为com，二级包名根据应用进行命名。类命名：类命采用驼峰命名规则，即首字母必须大写，假如为词组，则每个单词的首字母必须大写，类名只能使用名词或名词词组，力求类名简朴，不允许出现冗余的单词。继承自UIView的类以View结尾。继承自ViewController的类以ViewController结尾。保存数据的实体以Model结尾。方法的命名：规则：方法名第一个单词是一个动词，其首字母小写，其后的所有单词首字母大写。如：publicVoidthreadRun()类中常用方法命名：类的获取方法假如返回值为单个值，一般在头部加上单词“get”。假如返回值是数组或列表，要在头部加单词“find”如：publicStringgetUserName()、publiclist<String>findFriends()类的设立方法在被访问字段名的前面加上前缀set如：publicvoidsetName（Stringname）类的布尔型判断方法一般规定方法名使用单词is或has做前缀如：isNetWorkConnected（）构造方法应当用递增的方式写。参数个数少的在前变量命名规则：第一个单词首字母必须小写，往后的单词需要符合驼峰命名规则，即第一个字母大写。变量名尽也许的使用名词或名词词组。同样规定简朴易懂，不允许出现无意义的单词。如：StringuserName避免使用全局变量，假如用到必须加前缀‘Pub_’,同时需要在变量名体现其类型。成员变量命名与变量命名同样，在private字段前加上字母“m”。控件变量命名规则：一般的变量命名后加上控件名称IBOutletUILabel*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作者@version1.002023/01/20Creation(此文档的版本信息：版本号+创建时间)*/类注释每一个类都要包含如下格式的注释，以说明当前类的功能等。/*!@class类名@abstract这里可以写关于这个类的一些描述。*/枚举注释每一个枚举都需要包含相相应的enum描述，以及每个枚举值相应的含义。/*!@enum枚举名称@abstract关于这个enum的一些基本信息@constant各个相应值得含义，如：OKButton相应的是OK按钮的Tag*/协议注释协议需要注明是哪个类相应的protocol，以及自身的相关描述。/*!@protocol协议名称@abstract这是哪个类的protocol@discussion具体描述信息*/方法注释涉及当前方法的用途，当前方法参数的含义，当前方法返回值的内容和相应的错误参照。/*!@method方法名@abstract该方法的一些简要描述@discussion该方法的具体使用方式，需要注意的地方，假如你是设计一个抽象类或者一个共通类给给其他类继承的话，在这里需要具体描述一下如何使用这个方法。@paramtext参数列表@paramerror错误参照@result返回结果*/属性注释/*!@property属性名称@abstract该Property的一些基本描述。*/类别注释/*!@category类别名称@abstract哪个类的类别*/代码风格缩进规则：严禁使用tab进行缩进，缩进为4个空格.h文献空行可以使用空行的情况：文献说明与头文献包含(#import)之间类声明跟接口声明之间。头文献包含(#import)与@class之间@interface与@class之间头文献{}内，空1行开始写成员对象。头文献{}外，空1行开始写属性。属性与方法之间。方法与@end之间。假如需要声明protocol，空2行接着写。通常protocol写在@end后面，但是声明在@interface之前。方法与方法之间空1行。.m文献空行文献说明与头文献包含(#import)之间。头文献包含(#import)之间。@implementation和@synthesize之间。@synthesize与方法之间。变量声明后需要空1行。各功能块之间。#pragmamark与方法之间。空格关键字与其后的表达式之间需要加空格。单目操作符不应与操作数分开。除’,’外，其它双目操作符应与它们的操作数用空格隔开。.h中协议<>前面有一个空格。.h中成员声明时，类型与变量之间有至少1个空格。*号靠近变量，不靠近类型。@property后留1个空格，（）里面，逗号紧跟前一变量，与后一变量之间留1个空格。（）外面，先留1个空格，再声明属性。方法的+，-后面与（）。返回类型与*之间留1个空格，方法参数中返回类型与*之间留1个空格在多参数方法中，每个参数后面都有1个空格。Switch..case语句，代码块需要留4个空格。If语句嵌套，内部if语句需要留4个空格。ImportImport语句引入的顺序如下：IOSimports第三方库自定义.h文献在每组内部按字母排序，大写字母排在小写字母的前面。每个大组之间应当空一行。Log规则：统一使用自定的log服务，不直接使用系统自带。语句每行只能有一个语句每行代码最多不得操作100个字符。标准大括号风格大括号不单独占用一行；它们紧接着上一行书写。控制语句If语句判断中假如有常量，则应将常量放在判断式的右侧，如if(a>b)假如if语句成立的逻辑只有一句，则应当将其放在if同一行或用{}括起来。如：if(index>0)……if(index>0){……….}While语句循环语句中不允许出现表达式。如while（I<documents.getCount()）修改规范新增代码行新增代码行的前后应有注释行说明。//修改人，修改时间，修改说明新增代码行//修改结束删除代码行删除代码向的前后用注释行说明//修改人，修改时间，修改说明要删除的代码行(将要删除的语句进行注释)//修改结束修改代码行修改代码行以注释旧代码行后再新增代码行的方式进行。//修改人，修改时间，修改说明//修改前代码行开始//修改前代码行//修改前代码行结束//修改后代码行开始修改后代码行//修改结束严禁出现的情况永远不要有空的catch语句。替代方