Brian F爱
从专注于角图,Web技术以yobet英雄联盟及波特兰的Node.js的Google开发人员专家中学习。
广告 ·ultimatecourses.com.
用终极课程学习角度正确的方式

对象-C编码约定或指南

在开发框架时或作为团队的一部分开发时,有一套商定的编码指南是个好主意。

我很强烈地认为这很重要,以便代码一致,为团队中的每个人提供商定,可理解的代码。作为一种创造性的个人,开发人员非常容易开始攻击,几乎没有想到或意图代码结构,风格或排版。在我看来,这通常会导致一个泥浆

有些人可以说,使用尽可能少的时间(成本)的所需功能来获得一个项目和外门是一种完美的软件开发方法。这种方法可以,并为今天的许多业务工作。这通常在小型开发商店中看到,通常是一个独奏开发人员,他们正在为客户开发申请。他们可能会打算最终洗手,所以代码设计并不重要。或者,他们正在为将来维持应用程序的时间得到报酬,并且在一天结束时,哎呀,更具可费的时间更加有钱。所以,为什么要关注编码惯例和指南

为什么?

有几个原因有一套商定的编码约定/指南:

  • 在申请的寿命期间,通常在维护阶段花费比初始开发阶段更多的时间。
  • 应用程序的代码很可能被一个以上的人触及。这对于将同时在相同代码上工作的开发团队(希望使用源代码)是如此。而且,当新的开发人员添加到项目时,或者当原作者不再在项目中不再工作时,这也是如此。
  • 在维护代码(上面参见#1)时,读取和理解代码不仅是最小化维护期间所花费的时间的关键,而且是最小化代码维护期间创建的错误和问题。
  • 如果您的代码是由其他开发人员使用的代码(将API识别或将代码销售给某人),那么他们需要轻松阅读和理解您的代码。如果他们与您的代码集成,他们将欣赏您的一致性和清晰度。

指导原则应该涵盖什么?

编码指南应该涵盖主题,如:

  • 文件和文件夹命名
  • 文件和文件夹组织
  • 缩进
  • 白色空间
  • 评论使用,位置和风格
  • 变量命名和大写
  • 方法命名和大写
  • 类,接口和协议命名和大写
  • 编程原则
  • 设计模式和常见解决问题

Apple的编码指南

幸运的是,对于Objective-C开发人员来说,Apple创造了一个完整的编码指南那个咒语:

  • 代码命名基本
  • 方法命名
  • 命名功能
  • 命名属性和数据类型
  • 可接受的缩写和首字母缩略词

以下是他们命名约定的快速概述:

  • 命名应该对简洁起见阐明清晰度。
  • 命名不应包括缩写或首字母缩略词,除非在可接受的缩写列表中。
  • 命名应在整个代码库中保持一致。
  • 私有实例变量应以下划线开头_
  • 方法名称应为较低的驼峰案例。他们不应该以下划线开头。
  • 如果使用缩写,例如::- (nsstring *)pdfpath;
  • 类应该使用名词命名。
  • 协议应使用动词的Gerund(结束)命名。
  • 仅对常见的类集使用前缀。例如,特定框架的所有类都应以缩写前缀:UI(Uikit),NS(基础),CF(Core Foundation)或RK(RESTKIT)开始。
  • 返回某事的方法,应该指示不使用“get”。
  • 返回布尔值的方法应该使用“是”前缀。
  • 方法参数应指出参数在参数之前使用关键字所需的原因。

Brian F爱

嗨,我是布莱恩。我对类型名称,Angular和node.js感兴趣我嫁给了我最好的朋友邦妮,我住在波特兰和我滑雪(很多)。