EEPW论坛

　　毕业后从事软件工作至少20读年了。大学时代编程，从未养成写代码加注释的习惯。这个习惯严格来说，是从开始做对日外包软件工作以后开始的。无论心中怎么反感日本这个国家，还是要感谢他们。毕业后正年轻，特立独行，不大容易听进去别人的意见。但从事外包项目后，别人立的规矩就不得不服从了。最初的时候，虽然不情愿，觉得耽误时间，但做代码必须要加注释了，哪怕最初自己的日语不好。慢慢的做的多了，才发现：做软件可不是仅仅写好代码就行的，还要写一大堆文档。按照日本那边的规矩，要有概要设计书、详细设计书、单体测试设计书、结合测试设计书、总合测试设计书等一大堆东西。对大多数程序员来说，这些工作都是要花时间的，也是最讨厌的。事实上像我这样半路出家的软件工程师，是没有经过专门的软件开发教育，也不知道大学里专门学软件的，是否要学这些课程。

　　必须说明一下，编码注释这一条，即使你不愿意做，也必须要做。哪怕这个程序并不是大项目的一部分，哪怕只是你私人做的一个小项目。作为一个个人观点：只要是人制作的软件，就一定会存在错误。软件代码行数越多，错误就会越多。有些错误是单纯的代码语言上的使用错误，有些是处理逻辑上的错误，有些是和业务有关的错误。出现了错误，是要修改的。如果没有注释，处理逻辑上的错误和业务处理上的错误，指望从代码的处理过程中发现是很难的，更不用说维护者和开发者不是一个人的时候，其难度会更大。这个时候如果有了注释，就相对容易找到错误点了。这就是我们一直要求的必须书写代码注释的根本原因。

　　现在的软件项目，往往规模很大。涉及前台、后台、数据库等不同部分，同时可能还会涉及不同设备上的应用（手机、平板、计算机、单片机等）。这个时候，项目相关的设计书，也就变得同样重要了。没有设计书，出现的错误，属于哪个业务分支、哪个模块也就不好定位。因此写好设计书，也是一个高级程序员必须具备的能力。

　　对于刚入行的软件工程师们，建议你们一定要养成写代码加注释的基本习惯。这里说的注释，不仅仅是指某行代码，某个函数，还包括某个处理类、某个文件，项目构成的说明等信息。作为程序员，为了向更高层次发展，还需要注意在工作过程中，学习各种设计书的书写方式，同时要学会站在一定高度上看待项目的构成和运作。毕竟水平越高，获得报酬也会更多。躺平虽然省心省力，对生活水平的提高可没有一点帮助。