易星科技iphone编码规范与指导V1.0

易星科技iphone编码规范与指导V1.0

ID:41962906

大小:66.16 KB

页数:5页

时间:2019-09-05

易星科技iphone编码规范与指导V1.0_第1页
易星科技iphone编码规范与指导V1.0_第2页
易星科技iphone编码规范与指导V1.0_第3页
易星科技iphone编码规范与指导V1.0_第4页
易星科技iphone编码规范与指导V1.0_第5页
资源描述:

《易星科技iphone编码规范与指导V1.0》由会员上传分享,免费在线阅读,更多相关内容在工程资料-天天文库

1、iphone编码规范与指导!!■(易星科技)推荐浏览设置屏幕分辨率:>1024X768字体:中(Ctrl+鼠标滚轮设置)最大化本窗口文档控制版本号修改时间修改内容修改人1.02011-4-12创建贺发虎概述对于任何工程项目来说,统一的施工标准都是保证工程质冕的重要因素。堪称当今人类最抽象、最复杂的工程一软件工程,白然更加不能例外。高品质、易维护的软件开发离不开清晰严格的编码规范。本文档详细描述object-C软件开发过程中的编码规范。本规范也适用于所冇在文档中出现的源码。文件结构所有iphone的源文件均必须包含一个规范的说明,说明包含了该文件的名称、功能概述、作者、版权和版本历史信息等内容。

2、文件头和函数的说明的格式为:1.文件头说明/*fi!eName模块名:V模块名称〉文件名:V文件名〉实现功能:V描述该文件实现的主要功能〉作者:V作者部门和姓名〉版本:<当前版本号〉创建日期:备注:V其它说明〉修改tl期:v日期格式:yyyy-mm-dd>修改人:v修改人〉修改内容:<修改内容〉fileName*/2.函数说明函数名称:<函数名称〉函数功能:V函数功能〉参数:V参数说明〉也可以说明返回值的类型,或是两者〉返回说明:V可以直接说明返回值,作者:<作者部门和姓名〉创建I」期:<日期格式:YYYY-MM-DD>修改口期:<口期格式:YYYY-MM-DD>备注:v其它说明〉**虫***

3、虫*******虫***虫***虫***虫*******虫*******虫*******虫***虫***虫*******虫***虫***虫***/3・头文件的引用说明在h文件中引用其他类用@classfileName;在m文件屮引用其他类都用#import"fileName.h"4.文件的组织结构新建iphone工程有5个组(文件夹),分别是Classes,OtherSource,Resources,Frameworks,Productso在Classes卜•面一般放些公共的类,ifij其他类及视图统一放在View(这个组是我们自己创建)文件下面。如果工程屮分类过多,则可以在View下面再新建

4、组放类及视图,依次类推;而所有一些资源文件,如图片,声音等都放在Resources组下面,其他-些组默认;另外,如果有需要则可以新建组放另外一些文件。命名规则如果想要有效的管理一个稍微复杂一点的体系,针对其中事物的一套统一、带层次结构、清晰明了的命名准则就是必不可少而且非常好用的工貝。活跃在生物学、化学、军队、监狱、黑社会、恐怖组织等各个领域内的大量冇识先辈们都曾经无数次地以实际行动证明了以上公理的正确性。除了上帝(设它可以改变世间万物的秩序)以外,相信没人有实力对它不屑一顾。在软件开发这一高度抽象而且十分复杂的活动小,命名规则的重要性更显得尤为突出。一套定义良好并且完整的、在整个项1=1屮统

5、一使用的命名规范将人人提升源代码的可读性和软件的可维护性。在引入细节Z前,先说明一下命名规范的整体原则:同一性在编写一个子模块或派牛:类的时候,要遵循其基类或整体模块的命名风格,保持命名风格在整个模块中的同一性。标识符组成标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确。最小化长度和最人化信息量原则在保持一个标识符意思明确的同吋,应当尽量缩短其长度。避免过于相似不要出现仅靠大小写区分的相似的标识符,例如“产与T”,"function"与"Function"等等。避免在不同级别的作用域屮重名程序屮不要出现名字完全相同的局部变量和全局变最,尽管两者的作用域不同而不会发生语法

6、错误,但容易使人误解。止确命名具冇互斥意义的标识符用正确的反义词组命名具冇互斥意义的标识符,女口:minValuelnteger和maxValuelnteger,getName()和setName()等5.h,m,nib文件名命名除了异常类等个别情况(不希望被用户看作一个普通的、正常的类Z情况)夕卜,iphone的h,m,nib文件名命名应该遵循以下准则:(1)h,m,nib文件名命名的名称都要以大写字母开头;(2)如果是一般的视图类,贝I」后而加上VicwController,即h,m,nib文件名的名称仿效分别为:***VicwControllcr.h***VicwControllcr.m

7、>***VicwControllcr.xib;(3)如果是自定义的视图类,,则后面加上CustomCcll,即h,m,nib文件名的名称仿效分别为:***CustomCell.hs***CustomCell.m>***CustomCell.xib;6.函数(1)所有函数名命名的名称都要以小写字母开头;(2)如果是事件的名称,则要先以对象加上对象的事件开头,如buttonClicked***>tex

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。