JavaScript 的註解主要分兩種寫法:單行註解與多行註解。除此之外,還有一個常被忽略的應用——用 HTML 註解把腳本包起來,讓不支援 JavaScript 的舊瀏覽器不會把程式碼當成文字顯示出來。
單行註解
單行註解以 // 開頭,到該行結尾為止。範例:
<html>
<head>
<title>javascript 單行註解</title>
<script language="javascript">
<!--
// 第一個 alert
alert("An alert triggered by JavaScript!");
// 第二個 alert
alert("A second message appears!");
// -->
</script>
</head>
<body></body>
</html>
多行註解
多行註解以 /* 開始、*/ 結束,適合一次說明一整段邏輯。
<html>
<head>
<title>javascript 多行註解</title>
<script language="javascript">
<!--
/*
下面兩個 alert() 會各彈出一個提示視窗,
注意第二個必須等第一個按下「確定」之後才會出現。
*/
alert("An alert triggered by JavaScript!");
alert("A second message appears!");
// -->
</script>
</head>
<body></body>
</html>
順帶解決「瀏覽器不支援 JavaScript」的問題
如果不確定使用者的瀏覽器是否支援 JavaScript,可以借用 HTML 的註解符號來做向下相容。HTML 註解以 <!-- 開始、--> 結束;把 JavaScript 寫在這段註解裡面,對於不支援 JavaScript 的瀏覽器來說,整段內容會被當成註解處理,不會以純文字形式露出來。
下面這個例子會在支援 JavaScript 的環境中輸出一段文字,不支援時則什麼都不顯示:
<html>
<head>
<title>Hide scripts using comments.</title>
<script language="javascript" type="text/javascript">
<!--
document.write("您的瀏覽器支援 JavaScript 腳本!");
//-->
</script>
</head>
<body>
Page content here...
</body>
</html>
這招在今天雖然用處不大(現代瀏覽器幾乎都支援 JavaScript),但理解它的原理,有助於你讀懂早期程式碼中那些看起來有點多餘的 <!-- 與 //-->。
希望這份整理對你有幫助。