学习目录:
- 命名规范
- 注释
一:命名规范
1.有含义
给一个对象命名时建议采用修饰+类型的方式. 如果只用修饰命名会引起歧义, 比如title (这个到底是个NSString还是UILabel?). 同样的, 如果只用类型来命名则会缺失作用信息, 比如label (好吧, 我知道你是个UILabel, 但是我不知道它是用来做什么的呀?). So, 正确的命名方式为:
2.尽量少用缩写
3.驼峰命名法
4.自己封装的东西有必要的可以加前缀
|
5.类名首字母大写,方法首字母小写,方法中的参数首字母小写,同时尽量让方法的命名读起来像一句话,能够传达出方法的意思,同时取值方法前不要加前缀“get”。
6.变量名小写字母开头
7.常量(宏)以小写字母k开头,后续首字母大写
8.实例变量声明时变量名前面加下划线“_”,局部变量不用加。
9.枚举(类名+Type名称)
10.协议名称(类名+Delegate)
二:注释
代码注释的意义:
网友一:
注释的重要性是不容忽略的,代码常常以高傲的姿态面对注释,因为它实现了软件的主要功能,但是当软件出现bug,没有注释的代码就让人头疼了,尤其是在团队开发中,别人需要用到或是查阅自己的代码,没有注释就会让人很难读懂,甚至一段时间过去后,自己都会看不懂自己写的代码。为了提高沟通效率,所以大家应该统一规范,添加注释。
网友二:
注释不是翻译代码,对代码进行逐行解释,它应该用于解释业务逻辑,推理以及对将来的启示。注释对代码的维护和扩展有重要意义,尤其是在团队开发中。
使用规范:
1.声明的地方都要收注释(属性、方法)
2.逻辑复杂的地方,判断语句出现的地方
3.如果代码中的业务逻辑以后可能需要更新或修改,那就留下注释(
TODO: )
4.建议使用“#pragma mark”,方便阅读代码
三:其他细节
1.代码行度最大为100列(C++的是80)
2.声明类或方法时,注意空格的使用,参数过多时可换行保持对齐,
调用方法时也是如此,参数都写在一行或换行冒号对齐,
四:编程思想
面向对象的基本原则:
可复用, 易维护, 可扩展
1.封装:
尽可能保证 .h文件的简洁性,可以不公开的API就不要公开了,写在实现文件中即可。
2.设计模式:MVC、单例、代理、KVC和KVO等等,学习设计模式,尽可能学习使用封装思想,减少代码冗余,降低耦合度。
参考链接:
http://www.cocoachina.com/ios/20140520/8484.html (Objective-C代码规范)
http://www.cocoachina.com/ios/20151014/13678.html(iOS开发总结之代码规范)