• 增删功能,调整架构需要和其他开发者讨论,不要擅自更改讨论结果,严格遵循讨论结果进行开发。
  • 提交的文件不要保留无用的代码,务必了解每一行代码的作用。如果做不到,说明代码耦合性太强。
  • 每修改一个文件,就要对整个文件负责,保证代码符合规范。
  • 每次提交,都在代码文件夹或者其他合适的位置更新readme.md,描述本次更新的目的和结果。
  • 提交前写好测试脚本,建议放在main下,好的测试脚本就是最好的文档。
  • 不要写显而易见的注释,除非特别巧妙的算法,注释不要过长甚至超过代码本身。在难以理解或者新颖的地方加上注释。
  • 不要写超长的函数,一个函数解决一个功能,不要有复制粘贴式代码。
  • 一个文件里不要放不相关或者弱相关的类。强相关的类举例:HistoryError,DataHistory,HistorySet,前两者为后者服务。
  • 一个类解决一类功能,如果发现一个类有多个相关功能,做好类的封装,调用封装好的类分别完成。
  • 一行代码执行一个功能,尽量避免连续调用,比如foo().bar(),尤其是foo()(),其中foo函数返回值是一个函数。
  • 如果一个对象需要多次使用,将它保存成一个变量,而不是靠取下标或者函数返回值来引用。

results matching ""

    No results matching ""