我們經常需要在程式碼旁邊加上註解,好處很多:方便查找、方便比對、讓專案裡其他成員理解你的程式碼,也方便未來的自己理解與修改。
開始用 <!--,結束用 -->。
語法:
<!-- 註解的內容 -->
範例:
<!-- 這裡是註解 -->
<a href="https://www.example.com">連結文字</a>
<!-- 連結結束 -->
單行用兩個斜線:
// 這一行是註解
多行用斜線加星號:
/*
這一段都是註解
可以寫很多行
*/
CSS 只有多行寫法,用 /* 開始、*/ 結束。它在樣式表中同樣重要——能幫助你記起這段樣式的用途、對應到 HTML 的哪個位置。
/* ---------- 文字樣式開始 ---------- */
/* 白色 12px 文字 */
.dreamduwhite12px {
color: white;
font-size: 12px;
}
/* 黑色 16px 文字 */
.dreamdublack16px {
color: black;
font-size: 16px;
}
/* ---------- 文字樣式結束 ---------- */
// document.write("www.example.com");
/*
var a = "www.example.com";
var b = "du";
*/
<!-- 內容 -->/* 內容 */// 內容/* … */第一,過多的 JavaScript 註解會影響載入與執行效能。正式發布前,應該透過打包工具(如 terser、esbuild)移除註解並壓縮檔案,這在今天的建置流程中已是標準配備。
第二,註解塊中不能出現巢狀的 /* 或 */。如果在要註解的程式碼裡本來就有這些字元(例如正規表達式中可能出現),就會造成語法錯誤。遇到這種情況時,改用 // 逐行註解會安全得多。
補充一個不同語言間的小陷阱:在 HTML 內部嵌 JavaScript 時,<!-- 這種 HTML 註解在 <script> 區塊裡的行為與在 HTML 中不同,早期是為了相容舊瀏覽器而保留的寫法,現代請一律使用 // 與 /* */。而在 JSX 中,註解必須寫成 {/* 內容 */},這又是一套不同的規則。