寫代碼時加注釋是為了提高代碼可讀性，方便自己和他人理解。應在關(guān)鍵地方添加注釋，單行注釋（//）適合解釋單行代碼或變量作用，如說明邏輯目的、調(diào)試屏蔽代碼；多行注釋（/ /）適合完整說明函數(shù)用途、參數(shù)含義及注意事項，并可用于臨時屏蔽代碼段；注釋應清晰實用，避免重復代碼內(nèi)容、不相關(guān)背景或過時信息，應說明“為什么”而非僅“做了什么”，并標明公共函數(shù)的輸入輸出及副作用；選擇單行或多行注釋取決于內(nèi)容長度與上下文需求，html/css中只能使用多行注釋；團隊開發(fā)中應遵循統(tǒng)一規(guī)范，保持風格一致。
寫代碼時加注釋，是讓自己和別人以后更容易看懂這段代碼在干什么。很多人一開始寫代碼都不太注意注釋，結(jié)果回過頭來看自己寫的代碼都得想半天。其實只要在關(guān)鍵地方加上幾句說明，就能省掉很多理解成本。
什么時候該用單行注釋（//）
單行注釋適合寫在某一行代碼的上方或后面，用來解釋這行代碼做了什么。它的優(yōu)點是簡潔，不會顯得累贅。
比如：
// 計算總價并保留兩位小數(shù) const totalPrice = (price * quantity).toFixed(2);
或者像這樣寫在代碼后面：
let count = 0; // 初始化計數(shù)器
適用場景：
- 解釋某個變量的作用
- 說明某段邏輯的目的
- 暫時屏蔽某行代碼（調(diào)試時常用）
這種寫法特別適合在函數(shù)內(nèi)部、邏輯分支里做簡單說明，不需要大段文字也能讓人一目了然。
多行注釋（/ /）更適合哪些情況
多行注釋適合寫一段比較完整的說明，比如函數(shù)用途、參數(shù)含義、注意事項等。它不會打斷代碼結(jié)構(gòu)，適合寫稍長一點的解釋。
比如：
/* * 獲取用戶信息 * 參數(shù)： * userId: 用戶唯一標識符 * 返回值： * 包含用戶名和郵箱的對象 */ function getUserInfo(userId) { // ... }
也可以臨時把一段代碼“注釋掉”來測試效果：
/* console.log('調(diào)試信息'); fetchData(); */
不過要注意的是，在有些語言中（比如HTML、css），只能使用多行注釋，不能用//。
注釋也要講究清晰和實用
寫注釋不是為了湊字數(shù)，而是要寫出真正有用的信息。比如下面這些做法就不太合適：
- 注釋內(nèi)容和代碼重復：“設(shè)置標題”寫在title = ‘首頁’旁邊
- 寫一堆不相關(guān)的背景故事
- 忘記更新注釋，導致注釋和實際代碼不符
好注釋的標準：
- 簡潔明確，不說廢話
- 解釋“為什么”，而不是“做了什么”
- 如果是公共函數(shù)，說明輸入輸出和副作用
比如這樣寫更好：
// 需要先轉(zhuǎn)成整數(shù)，防止字符串拼接出錯 const num = parseInt(inputValue, 10);
單行還是多行？看場景選就好
沒有絕對正確的選擇，主要看你要表達的內(nèi)容長度和上下文是否需要。一般來說：
- 想說一句兩句，用//
- 要寫個說明文檔式的注釋，用/* */
- 在不同語言中也略有差異，比如HTML/CSS只能用多行注釋
另外，團隊有統(tǒng)一規(guī)范的話，按規(guī)范來就行。如果沒有，保持一致風格也很重要。
基本上就這些。寫注釋不是難事，但確實容易被忽略。花點時間寫清楚，回頭省不少麻煩。
