【翻译】苹果官网的命名规范之 Code Naming Basics-General Principles
苹果官方原文链接:General Principles
代码命名基本原则:通用规范
代码含义清晰
尽可能将代码写的简洁并且明白是最好的,不过代码清晰度不应该因为过度的简洁而受到影响。例如:
代码 |
解释 |
---|---|
|
命名很好 |
|
不太清晰,什么要被插入?at是指什么? |
|
命名很好 |
|
命名很好,因为他指明了(要移除)参数中的对象 |
|
不清晰,移除什么? |
通常情况下,不要用单词的缩写,即使单词很长。否则代码会变得很难读
代码 |
解释 |
---|---|
|
命名很好 |
|
不太清晰. |
|
命名很好. |
|
不太清晰. |
你或许认为一些单词的缩写大家都明白,但是不一定。尤其当其他在不同环境下或者不同语言背景吓的开发者看到你写的方法或者函数名称时。当然不排除有些单词缩写已经流行了很长时间并且很通用。你可以继续使用它。
在接口命名中,避免歧义,像一些方法名称可以被解释为多种含义。例如
代码 |
解释 |
---|---|
|
发送一个端口 还是 返回一个发送端口的名称? |
|
显示一个姓名?还是返回一个用户名称? |
一致性
在整个Cocoa 编码接口中,尽量使用一致的命名。如果你不确定的话,看一看头文件或者参考文档。
当你编写了一个类中需要用到多态的时候,代码一致性显得尤为重要。在不同的类中,命名相同的方法应该做同样的事情。例如
代码 |
解释 |
---|---|
|
在 |
|
在一系列的Cocoa 类中均有定义 |
命名不要自我指示。例如 user.username 用 user.name 即可
代码 |
解释 |
---|---|
|
可以. |
|
NSString已经是对象类型,不必要的在加object |
类和协议的命名
一个类的名称应该包含一个能够表明该类所要表达的意思或者功能。类名需要一个适当的前缀。Foundation和Application框架已经有很多例子了,例如:NSString,NSDate,NSScanner,UIButton等
协议(Protocol)应该根据自身所包含的行为来命名
大多数协议都定义了相关联的方法但是并不和一些特定的类有联系。这种协议命名不能和类命名混淆。一种通用的做法就是加 ing
NSLocking (好的命名) NSLock(不像协议的命名,更像某个类的命名)
头文件
定义相关的类或者协议。在一组相关的类,协议,分类等。把声明放在一个文件中,该文件包含主类、类别或协议的名称。
头文件 |
定义 |
---|---|
|
|
|
|
包含框架头文件。每一个框架都应该有一个头文件,并且头文件命名和框架命名一致,头文件中包含框架中所有的公开头文件。例如:Foundation.h (Foundation框架),AFNetworking.h
备注:
ambiguity 歧义
interpret 解释
【翻译】苹果官网的命名规范之 Code Naming Basics-General Principles的更多相关文章
- 【翻译】苹果官网的命名规范之 Naming Properties and Data Types
苹果官方原文:Naming Properties and Data Types 前言:纯属练习英语和学习.翻译错误和不通顺的地方敬请谅解和指正.O(∩_∩)O 属性和数据类型的命名 本节讲述了属性定义 ...
- 验证Xcode真伪的方法,来自苹果官网
验证Xcode真伪的方法,来自苹果官网 Xcode的验证你的版本 2015年9月22日 注意:中文为有道翻译,看下验证方法即可. 我们最近将应用程序从应用程序商店,还建有Xcode的假冒 ...
- 新型钓鱼手段预警:你看到的 аррӏе.com 真是苹果官网?
研究人员发现一种"几乎无法检测"的新型钓鱼攻击,就连最细心的网民也难以辨别.黑客可通过利用已知漏洞在 Chrome.Firefox 与 Opera 浏览器中伪造显示合法网站域名(例 ...
- 如何在苹果官网下载旧版本的Xcode
如何在苹果官网下载旧版本的Xcode 前段时间XcodeGhost事件让很多应用中招,不乏一些知名的互联网公司开发的应用.事件的起因是开发者使用了非官方的Xcode,这些Xcode带有xcodegho ...
- APP Distribution Guide 苹果官网
https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppDistributionGuide/Introduct ...
- [WPF] 抄抄超强的苹果官网滚动文字特效实现
1. 前言 今天 ChokCoco 大佬发布了一篇博客 超强的苹果官网滚动文字特效实现,iPhone 我是买不起的,但不妨碍我对抄特效感兴趣,正好我这周安排的工作已经完成了,于是有空练练手实现了一个 ...
- bcache 状态/配置 文件详细介绍(翻译自官网)
声明: 文中 斜体带下划线 的段落为翻译不够准确的段落 原文:https://www.kernel.org/doc/Documentation/bcache.txt 官网:https://bcach ...
- 苹果官网 demo The Elements 阅读随笔
The Elements https://developer.apple.com/library/ios/samplecode/TheElements/Introduction/Intro.html# ...
- 如何在苹果官网下载旧版本的Xcode 方法
1 在百度里输入“苹果开发者中心“,进入以下页面.点击页面中的“Member Center" 2 出现登录界面.这是需要苹果开发者帐号的,没有帐号的可以选择“Create Apple ...
随机推荐
- oracle 单实例DG(配置篇二)
一,DG搭建实例--主库配置 one : 归档配置 01,查看归档 1 select log_mode,force_logging from v$database; 02,开启归档 关闭数据库重新启 ...
- Hadoop Ecosystem related ports
本文总结了Hadoop生态系统中各个组件使用的端口,包括了HDFS,Map Reduce,HBase,Hive,Spark,WebHCat,Impala,Alluxio,Sqoop等,后续会持续更新. ...
- opensuse12.3 桌面设置备忘录
工作空间外观 窗口装饰 ghost deco2.2 光标主题 ringG 桌面主题 ghost 欢迎屏幕 login-scan-splash-cg 应用程序外观 风格 部件样式 Oxygen 颜色 g ...
- linux_api之进程环境
本篇索引: 1.引言 2.main函数 3.进程的终止方式 4.exit和_exit函数 5.atexit函数 7.环境表 8.C程序程序空间布局 9.存储空间的手动分配 10.库文件 1.引言 一个 ...
- java多线程lock的使用
看代码: package com.ming.thread.reentrantlock; import java.util.concurrent.locks.Lock; import java.util ...
- JavaScript 闭包初认识
1.简单的例子 首先从一个经典错误谈起,页面上有若干个div, 我们想给它们绑定一个onclick方法,于是有了下面的代码 <ul id="divTest"> < ...
- css3总结之居中
居中在前端布局上很常见,也很常用,也是最基本的技巧.居中效果在方向控制上基本可以分解成水平居中,垂直居中和水平垂直居中. 针对调整的元素不同,具体的处理方式上有些差异.这里我们先不讲绝对定位下的居中, ...
- asp.net中<input type=button>无法调用后台函数
例如:用<input id="bt1" type="button" runat="server" Onclick="btnL ...
- Android SharedPreferences存储数据
SharedPreferences是Android中最容易理解的数据存储技术,实际上SharedPreferences处理的就是一个key-value(键值对)SharedPreferences常用来 ...
- ArcGIS Enterprise 10.5.1 静默安装部署记录(Centos 7.2 minimal)- 5、安装Datastore
安装Datastore 解压datastore安装包,tar -xzvf ArcGIS_DataStore_Linux_1051_156441.tar.gz 切换到arcgis账户静默安装server ...