好的代码应该是直观的, 简单的. 直观就是"所思就所写", 想的是什么样就要把代码写成什么样子, 不要七拐八绕.
例如, 在做结构设计和流程设计时, 我们分析出某个功能流程应该这样做:
先做步骤1, 然后做步骤2.
什么是程序设计? 程序设计就是流程, 是串行化, 是先后顺序. 所以, 文档设计完毕之后, 必须写下这样的代码:
step1();
step2();
没错, 就是非常直观的两个函数调用语句, 一眼就能看出有先后顺序, 先 1 后 2. 但是, 初学者往往会把对 step2() 的调用, 放到 step1() 里面, 这就非常不直观了. 所以, 在做代码 review 时, 必须明确提出这个问题:
哪一段代码直观地体现了你的设计?
如果代码和设计思路没有在外在形式上一一对应, 那么那样的代码就是不直观的, 不好的, 因为看代码的人除非先看文档, 否则无法快速知晓流程上的先后顺序. 即使先看了文档, 也要费很大工夫才能从几百行代码中找到先后顺序关系的线索.
下面的代码, 你能一眼看出先后顺序吗?
func main() {
// 启动 10 个步骤1的线程
for i := 0; i < 10; i ++ {
go step1()
}
// 启动 1 个步骤2 的线程
go step2()
}
// 步骤1
func step1() {
for {
// do something...
}
wg.Done() // 等同于调用 step2()
}
// 步骤2
func step2() {
wg.Wait() // 等待步骤1执行完毕
// do something...
}
直观的代码应该是这样的:
func main() {
// 启动主线程
go func() {
// 先执行 step1, 再执行 step2
step1()
step2()
}()
}
// 步骤1
func step1() {
// 启动工作线程
for i := 0; i < 10; i ++ {
go sub1()
}
wg.Wait() // 等待工作线程结束
}
// 工作线程函数
func sub1() {
for {
// do something...
}
wg.Done()
}
// 步骤2
func step2() {
// do something...
}
虽然两者的代码在初学者眼中是一样的, 甚至有可能根据代码行数就错误地认为直观的写法太复杂, 但是, 直观的写法是自顶向下的, 代码本身就直接对应了设计文档, 即使文档丢失, 也能一眼看出来流程.
Loading ...