《代码整洁之道》[1]

书名：代码整洁之道
作者：Robert C.Martin
译者：韩磊
出版社：人民邮电出版社

---

【1】
编程的约规即是代码，糟糕的代码会毁掉一切。
童子军军规：让营地比你来时更干净。

【2】
命名要名副其实，体现本意，让人容易理解。
不要写需要很长注释才能解释清楚的命名；
不要写a1 a2 a3这样的命名；
不要写读不出来的命名，尽量避免专业术语，多使用和业务挂钩的命名；
避免误导：数字1和字母l，数字0和字母O；
不需要前缀标示变量，接口不需要I前缀；
(团队>个人，不要尽信书。
变量定义 m_Variable，参数定义 _parameters，局部变量 local)
类和对象名应该是名词或名词短语，方法名应该是动词或动词短语；
不要添加无用前缀、无用语境：个人名字缩写作为类名前缀！

【3】
函数应该、做好、只做一件事(快速积累通用型的事件方法函数，赞)；
每个函数对应一个抽象层级 a->b->c->d 自顶向下；
最理想的参数数量是0(本人经常写3-5个的参数，同事有些过11个，略略略)；
使用异常代替返回错误码(基本用Debug.Log()，更没有抽离Try/Catch)；
功能相同、相似的方法函数，学会整理、保存；学会提取为泛型T、接口

【4】
好的注释是编码非常重要的一部分(核心功能没有注释，调用乱七八糟的代码，还不如自己重写)；
注释可以提供信息(如：说明参数)
可以表示意图(如：实现某一个功能目的)
可以警示(如：错误的调用会导致的结果）;
不要写语义不明的注释(解释半天还要把解释再解释一遍，搞笑吧)；
不要写多余的注释(看代码就知道了，何必多占一行)；
不要写误导性注释(本来会调用的，看了注释不会了);
不要写循规式注释(每个变量搞个注释，还复制错误)；
不要写日志式注释(有时间记录心情，还不如看看源码)；
不要写不明显的注释(在a代码头上，说的却是b代码)；
能用类名、函数名、变量名、参数名等说明的尽量不要写注释

【5】
一行代码80-120个字符；
一个文件不超过200行代码；
缩进、括号位置、空格、符号间隔等可vs设置(团队>个人)；
(外部库 - 变量区 - unity生命周期函数 - 自定义函数)