我研究所是在國外念的,作業是教授親自一行一行地看
所以我們公司也有這些要求,但是因為經過訓練,就很容易習慣了 囧
: 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,讓接手的人可以更快瞭解這是做啥,怎麼用
: 上面除了第六項其他都開始做了
: 不知道大家的公司的情況是怎麼樣
我們公司是年資有點久的系統廠,但是還是有這些規定
反而是之前待的新創比較沒這些習慣,所以還是看主導的人是誰~