5、代码编写的最佳实践与技巧

代码编写的最佳实践与技巧

1. 遵循标准，避免特立独行

在开发过程中，不要因为个人喜好而忽视公司或行业的标准。编写不符合标准的代码会导致其无法融入公司的环境，因为公司的持续集成检查、IDE 插件、单元测试、代码检查、日志聚合工具、指标仪表盘和数据管道等都已经集成好了，采用自定义方法的成本会很高。

即便个人偏好的方法可能更好，但特立独行仍不是个好主意。短期内，应跟随大家的做法，尝试理解标准方法背后的原因，因为它可能解决了一些不明显的问题。若无法找出合理原因，可以向周围人询问；若还是找不到答案，就与经理和负责该技术的团队进行沟通。

改变标准需要考虑多个维度，如优先级、所有权、成本和实施细节等。说服团队放弃他们负责的东西并非易事，会有很多不同的意见，所以需要务实。虽然改变广泛采用的东西进展缓慢，但这并不意味着不值得去做。通过正确的渠道推动改变，会有很多好处，比如可以接触到组织的其他部分，有利于建立人脉和获得晋升机会，还能成为新解决方案的早期采用者，率先使用新事物。不过，不要因此分散日常工作的注意力，并且要让经理知道你在这些项目上花费了时间。

2. 避免无意义的分支和重写

2.1 不提交上游就不分支

分支是另一个源代码仓库的完整、独立副本，有自己的主干、分支和标签。在像 GitHub 这样的代码共享平台上，分支常用于向上游仓库提交拉取请求之前，这能让没有主仓库写入权限的人为项目做出贡献，是正常且健康的做法。

但如果没有将更改贡献回上游的意图，分支就不太健康了。这种情况通常发生在对项目方向存在分歧、原项目被弃用或难以将更改合并到主代码库时。维护公司内部的分支尤其有害，开发者常说“以后”会将更改贡献回上游