寫程式時,適當的註解能讓程式碼更具可讀性,也方便他人進行二次維護。本文說明 JavaScript 的兩種註解方式,並提醒一個容易踩的雷。
單行註解:以 // 開頭,從該符號到行尾皆為註解。
多行註解:以 /* 開始、*/ 結束,可跨越多行。
看下面這個例子:
/*
var rm_a = /a*/.match(s);
*/
這段程式本意是要把整段正則表達式註解掉,執行時卻拋出了語法錯誤。原因就在於——正則表達式 /a*/ 中本身就含有 */,它會被解讀為多行註解的「結束符號」,導致註解提前結束,剩下的內容變成非法程式碼。
這說明「區塊級註解」在特定情境下並不安全,尤其當被註解的內容含有 */ 時。若不小心犯了這種錯誤,排查起來往往相當棘手。因此,實務上更建議優先使用單行註解 // 來取代多行註解 /* */,尤其在註解整段程式碼時,能避免這類意料之外的語法衝突。