ios之编码规范详细说明

iOS代码规范:

所有代码规范全部遵循苹果sdk的原则,不清楚的请访问苹果SDK文档或下载官方Demo查看。

1、工程部分:

将项目中每个功能模块对应的源文件放入同一文件夹下,使用虚拟文件夹。

引用的.a和相关的文件,独立使用文件夹存放,并标明是SDK

2、类:

命名:首字母大写,其后每个单词首字母大写,类文件的名字必须与类中主要的@interface类名字一致。(例:RootViewController,PersonInfo)

category和protocol可以放在独立文件中,或放在某个类之前。

3、代码:

变量:所有变量命名遵循驼峰规则,变量名需保证见名知意,(例:NSString *personName = @"123",BOOL isTrue = YES)

除此之外还需满足以下条件:

临时变量以小写字母开头,其后每个单词首字母全部大写,尽量不使用数字和下划线。

全局变量以下划线开头,禁止使用数字,尽量不在中间使用下划线。

4、数据类型:

能使用Objective-C的数据类型,尽量使用Objective-C的数据类型,切忌交叉使用(哪怕你知道那原本就是一个类型)。

5、属性、方法

所有属性名不能以下划线开头,尽量不使用单词简写。(例:

@property (nonatomic,strong)NSString *orderNumber;

@property (nonatomic,strong)NSMutableDictionary *studentInfo;

方法名必须以小写字母开头,每个参数描述必须明确的描述后面的参数,每个形参必须确切的表示参数的作用,严禁出现  - (id)init:(NSString *)a b:(NSString *)b作此类的方法名。

6、语句、括号

所有语句必须遵循左对齐原则,括号位置需保持一致。

换行前注意语句对齐,嵌套语句中换行和括号必须依次缩进。

7、 注释、标记

每个不够明确的变量和属性之前,必须加上相关注释。

每个稍微复杂的方法,必须加上对功能的描述。

执行到关键步骤时,尽量使用语句提示其作用。

出现关键性的流程选择时,使用注释提示。

同一个类中出现其他引用,出现独立功能模块时,添加mark。

任意待优化、未完善、未测试、不确定的代码,需要添加mark。

8、宏、静态全局变量

尽量写在独立的文件中。

简短的宏命令尽量使用大写,稍长的可以大写开头,其后使用小写,但尽量添加下划线加以区分。

大量重复使用的数值尽量使用宏,嵌套层数过多、使用频率较高、格式固定无需较大更改的方法尽量使用宏。

常用设备信息、屏幕尺寸、固定参数尽量使用宏,接口地址、路径、固定参数可使用宏或全局静态变量。

时间: 2024-10-30 04:27:20

ios之编码规范详细说明的相关文章

iOS:Cocoa编码规范 -[译]Coding Guidelines for Cocoa

--原文地址:https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/FrameworkImpl.html Cocoa编码规范 --前言 用公共API开发一个Cocoa框架,插件,或其他可执行目标,里面的命名编写和规范不同于一般应用程序的开发.因为你开发出来东西是给开发者用的看的,并且他们不熟悉你的编程接口.这个时候API的命名约定就派上用场了,因为它使你的写

Eclipse_Java编码规范详细设置

转载请注明来源:http://blog.csdn.net/u010194538/article/details/51167563 软件项目质量保证----编码规范. 一个公司团队有个编码规范是必须的,大部分公司的都一样,但每个不同的公司有一些特殊的要求. 编码规范的作用 提高可读性:有助于知识传递,加快工作交接 :统一全局,促进团队协作:减少名字增生,降低维护成本:强调变量之间的关系,降低缺陷引人的机会:提高程序员的个人能力 Eclipse开发样式 这里主要先从Eclipse工具说下: 设置工作

ios之编码规范具体说明

iOS代码规范: 所有代码规范所有遵循苹果sdk的原则,不清楚的请訪问苹果SDK文档或下载官方Demo查看. 1.project部分: 将项目中每一个功能模块相应的源文件放入同一目录下,使用虚拟目录. 引用的.a和相关的文件.独立使用目录存放.并标明是SDK 2.类: 命名:首字母大写,其后每一个单词首字母大写,类文件的名字必须与类中基本的@interface类名字一致.(例:RootViewController.PersonInfo) category和protocol能够放在独立文件里,或放

节选自“Discuz! 开放平台的编码规范”(通用的)

http://open.discuz.net/?ac=document&page=dev_coderule 本文字体字号大小(只针对本文编辑器): 项目描述                             字号          加重与否             例 重要内容标题                   18pt        重色                I. 代码编写规范,“序” 一般描述性文字                13px        不加重色    

iOS 注释的5要3不要和编码规范的26个方面

注释 代码注释,可以说是比代码本身更重要.这里有一些方法可以确保你写在代码中的注释是友好的: 不要重复阅读者已经知道的内容 能明确说明代码是做什么的注释对我们是没有帮助的. // If the color is red, turn it green if (color.is_red()) { color.turn_green(); }   要注释说明推理和历史 如果代码中的业务逻辑以后可能需要更新或更改,那就应该留下注释:) /* The API currently returns an arr

iOS编码规范参考

目录 1  注释 1.1  多行注释 1.2  单行注释 1.3  函数的注释 2  命名 2.1  常量的命名 2.2  函数的命名 2.3  变量的命名 2.3.1  成员变量 2.3.2  公共变量命名 2.3.3  实例变量命名 2.4  图片的命名 2.5  类的命名 2.5.1分类名 2.6  条件语句 2.7  变量 3  下划线 4  Immutable 实例初始化 5  类型 5.1  CGRect 函数 5.2  常量 5.3  枚举类型 5.4  布尔变量 5.5  单例

ES6(ECMAScript 2015) 编码规范与详细注意要点

ES6(ECMAScript 2015) 编码规范与详细注意要点,结合广发证券大量ES6实践项目整理而成, 已开源于Github中,持续更新中,欢迎PR以及提issue. Github地址:https://github.com/gf-web/es6-coding-style/ 本规范是基于JavaScript规范拟定的,只针对ES6相关内容进行约定 如变量命名,是否加分号等约定的请参考JavaScript规范 应注意目前的代码转换工具(如Babel,traceur)不够完善,有些特性须谨慎使用

【分享】[iOS翻译]Cocoa编码规范

http://www.cnblogs.com/yangfaxian/p/4673894.html 简介: 本文整理自Apple文档<Coding Guidelines for Cocoa>.这份文档原意是给Cocoa框架.插件及公共API开发者提供一些编码指导,实质上相当于Apple内部的编码规范.在多人协作时,一份统一的代码规范大大减少开发者之间的沟通成本,极力推荐. 目录: 一.代码命名基础 二.方法 三.函数 四.Property及其他 五.缩写 一.代码命名基础 1.通用原则 1.1 

[转载]Objective-C开发编码规范:4大方面解决开发中的规范性问题

Objective-C 编码规范,内容来自苹果.谷歌的文档翻译,自己的编码经验和对其它资料的总结. 概要 Objective-C 是一门面向对象的动态编程语言,主要用于编写 iOS 和 Mac 应用程序.关于 Objective-C 的编码规范,苹果和谷歌都已经有很好的总结: Apple Coding Guidelines for Cocoa Google Objective-C Style Guide 本文主要整合了对上述文档的翻译.作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编