diff的大小
bug修改,无所谓,该多大多大。一般bug fix不会超过100行。超过的要特别重视,想想究竟是什么原因造成。会不会是当初设计的问题。
一个diff,原则上不应该超过200-300行修改。但多了怎么办,把一个diff变成多个 – split to multiple changes.
每个diff应该只做一件事情
每个diff尽可少的做一个改动。这样可以尽可能的方便自己的管理(学会用git branch),和方便reviewer的代码审查。如果diff越集中做一件事,审查代码的人需要越短的时间来审查做出高质量的,整体效率越高。
一个function超过1屏 => split it, idiot.
统一的代码规范
比如文件名,变量或函数名的命名规范,分行的前置空2个spaces或4个;每行的字数(不应超过80char);如何使用public/private/protected;用左右括号的原则;空行的使用;文件和代码comments的位置 (比如,代码comment只能单独成行);对“// TODO:”的使用规范;macro,constant的使用;
等等等等。
这里没有特别的哪一种style一定更对,但是需要有一个大家统一的guideline,一起遵守,让整体的代码有统一的风格和标准。
最大的好处就是有利于readability.
object-oriented v.s function-oriented
Java本身就是面向对象,所以这个问题不大。但千万不要出现披着面向对象的外皮,在class里面写超长的面向函数的处理。这种情况下,尽可能的分流成helper function.
crispy & sufficient的注释
注释应当简洁但充分。有些人觉得代码应该speak for itself。我不大同意,代码是实现细节,适当的在意图上给予说明,可以大幅度的减少读代码的人的烦恼。
----淄博软件开发----