1.明确、简洁且专业
目标:具有非常优秀的可维护性,让维护人/走查人像看故事一样轻松看懂代码。
从本书中总结出的明确、简洁和专业是贯穿代码始终的性质。
2.命名
一句话:
每个变量、函数、类、字段等的命名都要具有明确简洁且专业的自注释性质!
评价指标的就是:能让别人一眼看懂这个东西是干嘛用的
3.函数
(1)函数体要短小(简洁)
(2)只有一个抽象层级,且只做一件事(明确、专业)
(3)参数尽量少:减少出错概率和测试成本(简洁)
(4)结构化编程:单入单出。个人不赞同这个做法
4.注释
关于代码,最好的注释就是代码本身,也就是自注释性质。比如给变量/函数起个好名字,比给函数头写注释强多了。
必要的注释:
法律信息、意图、警示、TODO、api文档
糟糕的注释:
日志(使用版本管理代替)、废话...
5.格式
垂直距离、水平错位,没啥好说的,审美问题,就问自己写出来的东西美观不美观就得了
6.后面再补