JavaScript 註解寫法規則

JavaScript 註解寫法規則相當的簡單,而且程式設計師可以利用 JavaScript 的註解來幫整支程式做妥善的解說,讓後續無論是自己維護或是其他的程式設計師接手,都能比較完善的維護,JavaScript 的註解與其他的程式語言類似,有分為單行註解與多行註解,這當時是可以應用在不同的情況,只要是被註解掉的字串就不會執行,所以的主流瀏覽器都支援 JavaScript 註解規則。

JavaScript 註解寫法範例一、單行註解
<script language=javascript>
<!--
document.write('測試單行註解 1<br>'); // 註解文字
//document.write('測試單行註解 2<br>');
document.write('測試單行註解 3'); // 註解文字
-->
</script>
範例的輸出結果
測試單行註解 1
測試單行註解 3
範例一共有三組 document.write 語法,功能是將小括號內的字串輸出到螢幕上,我們可以看到第一行的雙斜線(//)後方的字串並沒有輸出,僅輸出的小括號內的字串"測試單行註解 1",第三行也是同樣的效果。比較特別的是第二行,我們將雙斜線(//)寫在最前面,這樣會導致整行的字串(包含 JavaScript 語法)都被註解掉,所以都不會執行,JavaScript 的單行註解就是這樣,只要是在雙斜線後方的字串,都會被瀏覽器忽略掉,所以在寫注解時,請小心使用。

JavaScript 註解寫法範例二、多行註解
<script language=javascript>
<!--
/*
document.write('測試多行註解 1<br>');
document.write('測試多行註解 2<br>');
*/
document.write('測試多行註解 3'); // 註解文字
-->
</script>
範例的輸出結果
測試多行註解 3
範例二使用了 JavaScript 的多行註解,從多行註解的開頭符號(/*)到結束符號(*/)之間,無論是多少行的內容都不會被執行,因為全部都被註解掉了,所以範例只會執行第三組「document.write('測試多行註解 3');」的內容。多行註解常常用在寫程式的說明或標註該支程式的版本,非常實用。

延伸閱讀
© Copyright webtech.tw Since 2010