Swift 3.0 API设计准则
Posted Cocoa开发者社区
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Swift 3.0 API设计准则相关的知识，希望对你有一定的参考价值。
本文由CocoaChina译者自来也大人（）翻译，校对：hyhSuper（），欢迎指正。
原文：
这些正在开发的API指南草案是的一部分。
全文目录
基本要素
使用要点要清晰
清晰比简洁更重要
写明文档注释
命名
命名更加明确
符合语法规则
善用专业术语
约定
常规约定
参数
特别说明
-------------------------------------------------------
基本要素
把能够清晰使用作为你设计时最重要的目标。因为代码的可读性比代码自身更重要。
代码的清晰逻辑性比代码的简洁性更重要。Swift代码的简洁性，不是指使用最少的字符来实现程序代码。Swift编程的简洁性带来的一个副作用是由强类型系统和减少引用文件的特性决定的。
使用Swift的标记语法，为每一个方法和属性写注释性文本。最理想的情况，开发者能够从注释的签名和一两句总结中明白API的使用和意义。
/// Returns the first index where `element` appears in `self`,以上是关于Swift 3.0 API设计准则的主要内容，如果未能解决你的问题，请参考以下文章
在 Swift 3.0 中访问从 iTunes API 解析的 JSON 对象