代碼風格
語法
Figure brackets(大括號)
總結
- 對於很短的代碼,一行是可以接受的:例如
if (cond) return null
. - 但是括號中的每個語句單獨一行通常更好些。
函數在代碼下面
好的註釋
描述架構
提供組件的一個高層次的概況,它們如何相互作用、各種情況下的控制流程是什麼樣的… 簡而言之 —— 『代碼的鳥瞰圖』。有一個專門爲高層次架構圖而設計的圖表語言 UML,絕對值得學習。
記錄函數的用法
/**
* 返回 x 提高到 n 次冪之後的值。
*
* @param {number} x 要改變的值。
* @param {number} n 冪數,必須是一個自然數。
* @return {number} x 提高到 n 次冪之後的值。
*/
function pow(x, n) {
...
}