我研究所是在国外念的,作业是教授亲自一行一行地看
所以我们公司也有这些要求,但是因为经过训练,就很容易习惯了 囧
: 1. PR要merge的时候做Squash,因为这样git tree比较好看
这个带我的人也有要求
: 2. function超过一百行,就想要拆出来
我们教授是不超过50行,一行不能超过70个字
还会挑 function 和变量的命名,所以我也是不习惯看太长..
: 3. 完全遵照eslint的规范,任何warning都不能出现
这个有 vscode 提示,都蛮好解决的
: 4. 时常想回去重构程式
这个真的要看时间,但是如果想到有更好的写法,我自己会先记录下来
然后再利用下班时间或是工作有空档再改
: 5. 想把所有异步的function都改成promise
: 6. 想导入TDD以及jest,让系统减少错误发生机率(目前没人会这东西)
之前教授要求每个比较复杂的逻辑都要写 test (unit/integration)
没有写 test 作业会不及格,而且也是鼓励学生用 TDD
现在工作虽然比较没时间写完整,但是正所谓先求有再求好
至少 code coverage 先到个 50%,再依序补上去,我目前也是用 jest
: 7. 注解尽量删除,只留jsdoc,减少封装程式码
这个我们公司到没有要求,但一样教授有要求,所以自己也会写基本的说明
8. readme
我们公司要求写 readme,让接手的人可以更快了解这是做啥,怎么用
: 上面除了第六项其他都开始做了
: 不知道大家的公司的情况是怎么样
我们公司是年资有点久的系统厂,但是还是有这些规定
反而是之前待的新创比较没这些习惯,所以还是看主导的人是谁~