命名

名不正，则言不顺，言不顺，则事不成

── 孔子

命名很重要，随便一本逻辑学教材（如果读者有兴趣，此处推荐《逻辑学导论》）里都会有长篇大论来讨论命名的问题，我国古代在人才辈出的百家争鸣时期曾经出现过一个学派叫“名家”，专门讨论命名的问题，比如著名的“白马非马”、“离坚白”等，有空读读还是挺有趣的，比玩王者荣耀还有趣。笔者认为我国到目前为止出现了三个思想大解放时期：一，春秋战国时期的百家争鸣，可惜被秦皇的郡县制大一统所终结；二，民国时期，西方思想初涌，国人似惊雷轰顶，如梦方醒；三，当下，技术革命使得中央思想控制力度急剧下降，使得底层人民有了选择被谁控制思想的自由（请参考如今基于互联网的粉丝文化，圈子文化）。所以大家一定要好好写代码，才不负少年头呀。

清晰的结构

基本要求

if、while等关键字包裹的表达式，即使只有一句，也尽量使用大括号括起来

尽量避免使用直立人时代的goto语句

尽量避免过长的方法，把大方法拆分为数个小方法，方法的职能尽量单一

尽量避免重复代码，将其转移到公共工具中

尽量避免过大的类，拆分为数个类，各司其职

适当的注释，注释太多，说明代码本身的表达力可能还有待加强。有些实在难缠的逻辑，可以写详细注释，如果不写注释，离职时请注意不要泄露给擦屁股人自己的地址

优化算法

相信大部人做的项目都是性能不敏感的，只要稍稍注意就能做好。比如该使用分页的地方就使用分页，该根据条件查询数据库的就别一次都查出来，该优化数据库就优化数据库。

工作数年，大小项目经历若干，慢慢体会到，一个项目的开发顺利与否，并不在于技术选型是否为最佳实践，更多的时候，取决于开发方案和技术储备之间的平衡。做项目毕竟是要讲方案落地的，如果最佳实践中的技术成本，超出了开发者的落实能力，那就是坑，这时盲从最佳实践无异于挖坟。

关于文档，还需多说一句：只有再非常有必要写文档的情况下才写文档。如果写了一大堆可有可无的文档，代码更新后文档也要及时更新，很难做到的。一个新手面临着一堆和代码脱节的文档只会起误导作用，以代码本身的表达力和口头交流为主，以文档交流为辅，两手都要抓，一只手硬，一只手软

完