1 / 12
文档名称:

IOS编码安全规范.doc

格式:doc   大小:140KB   页数:12页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

IOS编码安全规范.doc

上传人:业精于勤 2021/12/6 文件大小:140 KB

下载得到文件列表

IOS编码安全规范.doc

文档介绍

文档介绍:移动端-IOS编码安全规范
命名
Bundle id命名:
规则:采用反域名命名规则,所有使用小写字母。一级包名为com,二级包名依照应用进行命名。
类命名:
类命采用驼峰命名规则,即首字母必要大写,如果为词组,则每个单词首字母必要大写,类名只能使用名词或名词词组,力求类名简朴,不容许浮现冗余单词。
继承自UIView类以View结尾。
继承自ViewController类以ViewController结尾。
保存数据实体以Model结尾。
办法命名:
规则:办法名第一种单词是一种动词,其首字母小写,其后所有单词首字母大写。
如:public Void threadRun()
类中惯用办法命名:
类获取办法
如果返回值为单个值,普通在头部加上单词“get”。如果返回值是数组或列表,要在头部加单词
“find”
如:public String getUserName() 、public list<String> 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 /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

最近更新