來自MIT6.031 軟件構造課的Reading材料的第4篇。
重點講授了
Code Review的意義,相關知識。
用其餘的篇幅講解了常用的代碼規範內容,包括:
- Don’t Repeat Yourself (DRY)
用代碼複用代替複製粘貼
- Comments where needed
在需要的時候 要註釋 + 才註釋
- Fail fast
如果出現錯誤,儘快掛斷,避免傳遞錯誤結果
- Avoid magic numbers
避免使用奇怪的來歷不明的數字,用更有意義的方式表達
- One purpose for each variable
每個變量名只是用一種含義,不復用
- Use good names
使用良好意義好的變量名
- No global variables
避免全局變量,儘可能縮小變量作用域
- Return results, don’t print them
在底層,返回結果,而非與用戶交互
- Use whitespace for readability
使用空格字符,如果要用Tab鍵,可使用編輯器轉化成空格
具體內容及筆記見下圖,筆記主要以手寫方式提供。