[awei研究室]程式註解的寫法CSS/PHP/JavaScript/HTML

2017.04.25 / 分類: awei研究室, JQUERY &CSS特效 / 0 則回應

程式設計師在編寫程式語言時都會有註解的需求，養成良好的程式註解習慣，一方面可以方便你隨時中斷編寫時的接續工作，而且在尤其Team work 的時候是團隊工程師都必須做到的基礎。且當你的程式碼越複雜，或是系統架構越來越大的時候，沒有寫註解，那可是會讓人眼花撩亂，讓自己或是整個團隊無所適從，如果必須修改某項功能時就會恨不得當初為何不寫下註解。

HTML的註解語法
無論是單行或多行，只要是在註解符號 <!– 與 –> 間的文字都不會顯示在網頁上。HTML 註解用起來相當的簡單容易

單行註解:
<!– 這裡是註解文字 –>

多行註解:
<!–
第一行註解文字
第二行註解文字
–>
CSS/PHP/JavaScript 的註解語法
CSS單行註解:透過雙斜線，後面加上註解文字這樣的寫法
<style type=”text/css”>
// 這是單行註解
// 這是單行註解
</style>

CSS多行註解:包在 /* 與 */ 裡面的文字將成為註解
<style type=”text/css”>
/*
第一行註解文字
第二行註解文字
*/
…
</style>
———————————————————————-

PHP單行註解:透過雙斜線，後面加上註解文字這樣的寫法
<?php
// 這是單行註解
// 這是單行註解
?>

PHP多行註解:包在 /* 與 */ 裡面的文字將成為註解
<?php
/*
第一行註解文字
第二行註解文字
*/
?>
———————————————————————-

Javascript單行註解:透過雙斜線，後面加上註解文字這樣的寫法
<script language=javascript><!– JavaScript 程式 // 註解文字 –></script>

Javascript多行註解:包在 /* 與 */ 裡面的文字將成為註解
<script language=javascript>
<!–
/*
JavaScript 註解文字
JavaScript 註解文字
*/
–>
</script>