程序员成长第十五篇：编码的注意事项

Posted 2022-07-12 产品经理石云升

业务也懂了，系统梳理了，要做的需求也弄懂了，是不是就该编码了？

对的，确实该编码了。但在写之前，有以下三个方面要注意。

统一格式

要和团队统一格式。否则你在本地格式化一下，会有很多冲突，代码就很难管理了。一般团队都会给你一个配置文件。配置一下即可。

编码规范

有一些编码规范，就算公司没要求，你对自己也要有要求。这方面的资料很多，我建议你在编码时问自己几个问题

1、我这样写，别人是否能通过命名看出代码的意思？好的命名可以传递大量的准确信息。不好的命名不会传递任何信息，糟糕的命名则会传递错误的信息。

2、对于类中的每个方法，我有讲清楚方法的目的、前置条件（传入的信息）、执行的结果、异常信息吗？

3、我的注释是必要的吗？它有传递正确的信息吗？新人最容易出现极端编码，要么不写注释，要么全是注释，注释比代码还多。

检验方法：让同事来看你写的代码。你什么都不讲的情况下，对方能不能看懂，能不能提出改进意见？

操作规范

1、在git上创建自己的工作区，哪怕团队就你一个人，你也要创建自己的工作区。

2、提交代码前，先拉取从git上拉取代码，如果有冲突，根据代码逻辑解决冲突。如果拿不定注意找对应同事沟通处理。

3、解决冲突后，要进行简单的测试。如：单元测试，功能测试。保证功能正常运行。

4、编写代码过程中，养成Ctrl + S 保存代码的习惯。避免突然断电等突发事件。

5、提交git代码时，要写清楚提交内容。不要全是什么”修复bug“之类的笼统的描述。

6、每个上线版本代码都要打分支tag，偶尔会有需求在老分支上做修改。

接下来，可以开始编码了。