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

iphone编码规范与指导推荐浏览设置屏幕分辨率：≥ 1024768 字体：中（Ctrl＋鼠标滚轮设置） 最大化本窗口 文档控制版本号 修改时间 修改内容 修改人2011-4-12 创建 贺发虎 概述对于任何工程项目来说，统一的施工标准都是保证工程质量的重要因素。堪称当今人类最抽象、最复杂的工程—软件工程，自然更加不能例外。高品质、易维护的软件开发离不开清晰严格的编码规范。本文档详细描述软件开发过程中的编码规范。本规范也适用于所有在文档中出现的源码。文件结构文件头/*fileName ====================================================================== 模块名 :模块名称 文件名 :文件名 实现功能:描述该文件实现的主要功能 作者 :作者部门和姓名 版本 :当前版本号 创建日期: 备注 :其它说明 修改日期:日期格式：yyyy-mm-dd 修改人 :修改人 修改内容:修改内容 ====================================================================== fileName*/ 函数说明 /****************************************************************************** 函数名称:函数名称 函数功能:函数功能 参数 :参数说明 返回说明:可以直接说明返回值，也可以说明返回值的类型，或是两者 作者 :作者部门和姓名 创建日期:日期格式：YYYY-MM-DD 修改日期:日期格式：YYYY-MM-DD 备注 :其它说明 ******************************************************************************/ 头文件的引用说明 在h文件中引用其他类用@class fileName； 在m文件中引用其他类都用#import “fileName.h” 文件的组织结构命名规则如果想要有效的管理一个稍微复杂一点的体系，针对其中事物的一套统一、带层次结构、清晰明了的命名准则就是必不可少而且非常好用的工具。 活跃在生物学、化学、军队、监狱、黑社会、恐怖组织等各个领域内的大量有识先辈们都曾经无数次地以实际行动证明了以上公理的正确性。除了上帝（设它可以改变世间万物的秩序）以外，相信没人有实力对它不屑一顾在软件开发这一高度抽象而且十分复杂的活动中，命名规则的重要性更显得尤为突出。一套定义良好并且完整的、在整个项目中统一使用的命名规范将大大提升源代码的可读性和软件的可维护性。 在引入细节之前，先说明一下命名规范的整体原则： 同一性 在编写一个子模块或派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格在整个模块中的同一性。 标识符组成 标识符采用英文单词或其组合，应当直观且可以拼读，可望文知意，用词应当准确。 最小化长度最大化信息量原则 在保持一个标识符意思明确的同时，应当尽量缩短其长度。避免过于相似 不要出现仅靠大小写区分的相似的标识符，例如“i”与“I”，“function”与“Function”等等。 避免在不同级别的作用域中重名 程序中不要出现名字完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但容易使人误解。 正确命名具有互斥意义的标识符 用正确的反义词组命名具有互斥意义的标识符，如：inValueInteger 和 axValueInteger，etName() 和 etName() 等 h，m，nib文件名命名 除了异常类等个别情况（不希望被用户看作一个普通的、正常的类之情况）外，的命名应该遵循以下准则：的名称都要以大写字母开头的名称都要以写字母开头的名称都要以写字母开头static const NSUInteger kUsernameRow = 0; 代码风格代码风格与版式代码风格的重要性怎么强调都不过分。一段稍长一点的无格式代码基本上就是不可读的。 先来看一下这方面的整体原则： 空行的使用 空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。 语句与代码行 一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 if”、for”、while”、try”、catch”等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加 “{ }” 。这样可以防止书写和修改代码时出现失误。 缩进和对齐 程序