命名冲突/命名规则
[详情看作者][1] 这里仅是自己做的笔记
[1]:https://onevcat.com/2016/01/create-framework/
属性方法的命名
1.在对系统已有的类添加 extension 的时候,需要特别注意命名的问题,为避免和第三方框架命名发生冲突,方法前加前缀(可唯一区别的)
2.关于属性和方法的命名选词的不同.(原作者这点讲有挺意思的).
2.1方法名应该是动词或者动词短语开头,而属性名应该是名词
app版本的命名
(具体来讲应该是第三方工具包的开发命名,app也适用吧).
x(major).y(minor).z(patch)
1.major - 公共 API 改动或者删减
2.minor - 新添加了公共 API
3.patch - bug 修正等
4.0.x.y 只遵守最后一条
major 的更改表示用户必须修改自己的代码才能继续使用框架;minor 表示框架添加了新的 API,但是现有用户不需要修改代码可以保持原有行为不变;而 patch 则代表 API 没有改变,仅只是内部修正。
但是有一个例外,那就是还没有正式到达 1.0.0 版本号的框架。 这种框架代表还在早期开发,没有正式发布,API 还在调整中,开发者只需要遵守 patch 的规则,也就是说 0.1.1 和 0.1.2 只有小的修正。但是 0.2 和 0.1 是可以完全不兼容。如果你正在使用一个未正式发布的框架的时候,需要小心这一点。