IOS编码及注释规范.doc

《IOS编码及注释规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、个人收集整理勿做商业用途IOS开发编码及命名规范个人收集整理勿做商业用途目录１、目的32、适用范围ﻩ33、编码规范33．１、文件ﻩ33.2、注释33.３、编码排版格式ﻩ５3．4、命名规范ﻩ6３.4.1、保留字ﻩ６3.4.2、方法7３.4.3、变量73.4.４、常量83.4.5、类９３．4．6图片命名９3.5、修改规范ﻩ93.5.２、新增代码行ﻩ９3．5．2、删除代码行ﻩ1０3.5.3、修改代码行１0３.5.4、其他规范10个人收集整理勿做商业用途1、目的统一规范ＸCode编辑环境下Ｏbjectiｖe-C的编码风格和标准２、适用范围适用于所

2、有用Obｊeｃｔｉve-Ｃ语言开发的项目。3、编码规范3.１、文件1)　项目文件必须使用一个有意义的名字一般用bunｄｌeId最后一位如lｅｎdｅr.xｃodeproｊ’。2)公共文件统一命名为’Ｐｕblic.h’。任何文件的命名尽量不要以中文命名。３)对于文件的目录要按如下结构创建:-Docｕmｅｎｔ(文档所在路径)-Heｌp（帮助文件所在路径)-图片等资源文件放在单独的目录与组(Ｇrｏup)中,如Ｉmａgｅs。-所有的viｅw放在单独的组(Gｒoｕp)中，如CustoｍView。-所有的ｖｉewＣｏｎtrolｌｅr放在单独的组中,如v

3、ｉeｗＣontrolｌeｒs。　-引用外部文件或者某个单独的功能时,放在单独的组中,例如：程序中使用了coｖerfloｗ功能,引用openflow的文件时，将其全部文件放在oｐｅnFlｏw这个组中。其view和viewcontrolｌｅr等文件的组织不受上面所规定的影响。　4)bunｄｌeＩd命名：公司的域名反过来最后一位是项目名称一般越短越好　举例:com.ppｄaｉ.*(coｍ.ｐpdai.lｅｎder)3．２、注释1）注释可以采用’/**/　’和’　//’两种注释符号，涉及到多行注释时,尽量使用’／**/’。2)对于一行代码的注释可

4、放在前一行及本行上，不允许放在下一行,更不允许在一行语句的中间加入注释。个人收集整理勿做商业用途3)　单元文件的文件头注释说明应按如下格式：/／//　文件名／/工程名／///　Creａtedby创建者on日期.//　Ｃｏpyrｉｇhｔ　201０　xｘｘ有限公司.Allrｉｇhtsresｅrved．／／//系统名称：//功能描述://修改记录:(仅记录功能修改）//　张三　2012－02-０２　创建该单元/／　小明　20１0-03－02增加本地点单功能。/／4)方法前面的注释遵循以下格式：如果某项没有,则以N/A表示例如：　/＊＊＊＊***

5、************＊＊**********＊******＊*****＊*＊****＊******　　　　函数名称：－(BＯＯL)showFｉveＡndＳixSｔａiｒRoｏmＣoｕntByＳtａtu　　函数描述:显示特定状态下五楼和六楼的房间数　　输入参数：(ＮSSｔring　*)ｓtatｕ:某状态。输出参数:（ｉnt*)roomＣounｔ:该状态房间数量。返回值:BＯOL：操作是否成功。　　　*＊*＊＊＊**********＊*＊＊＊*****＊*******＊＊*＊***＊*＊＊****＊******＊＊/-（voｉd)sｈow

6、FiveAndSｉxStairRoomCｏｕntByStａｔu:(NSStrｉnｇ*)ｓtatｕ　ｒoomＣｏunt:（int　＊)＿rｏｏmCount；或／＊*＊*＊****＊****＊*******＊****＊＊****＊*＊*＊**＊*＊*******＊＊**＊＊**　函数名称:-(NSUIｎtegeｒ)showFiveＡnｄSiｘＳtaｉrＲoｏｍＣoｕｎt　函数描述：显示五楼六楼的房间数。　输入参数：N/Ａ输出参数:N／A返回值:NSUIｎteger：房间数量。　　　*******＊**＊*＊＊＊＊*＊**＊********＊*

7、****＊＊***＊**********＊＊***＊*/-(NSUIntegｅr）ｓhoｗFiｖｅAｎdSixStairRoomCｏunt5)不必每行都加注释，在3~10行左右的段落做注释要好于每行都做注释,显而易见的代码不加注释。例如:iｆ（！returnValuｅ）　／/调用登录过程失败　　ß无用的注释{个人收集整理勿做商业用途　　　NSLog(@”登录失败”);｝３.3、编码排版格式１)　代码的缩进应使用空格（ＳＰＡＣE)，不能使用制表符（ＴＡＢ）,并且缩进以2个字符为单位。2)中括弧的每一个括弧在源程序中要单独占一行。例如　//不

8、正确用法　　for　(iｎt　i　=0;ｉ<　10；i++)　{ﻩ……　　}／/正确用法ｆor　(iｎt　i=0;ｉ<10;i＋+){……}3）　空格的使用　　a)　关键字与其后的表达式之间要