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

iphone编码规范与指导
(易星科技)
推荐浏览设置
屏幕分辨率:≥ 1024×768
字体:中(Ctrl+鼠标滚轮设置)
最大化本窗口
文档控制
版本号
修改时间
修改内容
修改人

2011-4-12
创建
贺发虎
概述
对于任何工程项目来说,统一的施工标准都是保证工程质量的重要因素。堪称当今人类最抽象、最复杂的工程—软件工程,自然更加不能例外。高品质、易维护的软件开发离不开清晰严格的编码规范。本文档详细描述object-C软件开发过程中的编码规范。本规范也适用于所有在文档中出现的源码。
文件结构
所有iphone的源文件均必须包含一个规范的说明,说明包含了该文件的名称、功能概述、作者、版权和版本历史信息等内容。文件头和函数的说明的格式为:
文件头说明
/*fileName
======================================================================
模块名 :<模块名称>
文件名 :<文件名>
实现功能:<描述该文件实现的主要功能>
作者 :<作者部门和姓名>
版本 :<当前版本号>
创建日期:
备注 :<其它说明>
修改日期:<日期格式:yyyy-mm-dd>
修改人 :<修改人>
修改内容:<修改内容>
======================================================================
fileName*/
函数说明
/******************************************************************************
函数名称:<函数名称>
函数功能:<函数功能>
参数 :<参数说明>
返回说明:<可以直接说明返回值,也可以说明返回值的类型,或是两者>
作者 :<作者部门和姓名>
创建日期:<日期格式:YYYY-MM-DD>
修改日期:<日期格式:YYYY-MM-DD>
备注 :<其它说明>
******************************************************************************/
头文件的引用说明
在h文件中引用其他类用***@class fileName;
在m文件中引用其他类都用#import “”
文件的组织结构
新建iphone工程有5个组(文件夹),分别是Classes,Other Source,Resources,Frameworks,Products。在Classes下面一般放些公共的类,而其他类及视图统一放在View(这个组是我们自己创建)文件下面。如果工程中分类过多,则可以在View下面再新建组放类及视图,依次类推;
而所有一些资源文件,如图片,声音等都放在Resources组下面,其他一些组默认;
另外,如果有需要则可以新建组放另外一些文件。
命名规则
如果想要有效的管理一个稍微复杂一点的体系,针对其中事物的一套统一、带层次结构、清晰明了的命名准则就是必不可少而且非常好用的工具。
活跃在生物学、化学、军队、监狱、黑社会、恐怖组织等各个领域内的大量