前端開(kāi)發(fā)代碼注釋的作用及使用示范

一、代碼注釋有什么用

1、和偽代碼一樣的作用，為接下來(lái)要實(shí)現(xiàn)的功能寫(xiě)出一個(gè)指導(dǎo)性的算法思路。只是沒(méi)有偽代碼詳細(xì)。但是也指出了完成此功能的大體算法思路。
2、給看代碼的人一個(gè)解釋性說(shuō)明。注意看代碼的人包括你自己。讓看你代碼的人可以快速的瀏覽你的代碼，不至于每看一行都要一行一行的看下去，才能明白你寫(xiě)的什么。

二、代碼注釋規(guī)范，遵循以下原則

1、能夠幫助讀者更好的了解代碼邏輯與結(jié)構(gòu)
2、特別的或不容易理解的寫(xiě)法可以解釋說(shuō)明
3、特殊標(biāo)記注釋?zhuān)喝?TODO、FIXME 等有特殊含義的標(biāo)記
4、文件注釋?zhuān)翰糠忠?guī)定會(huì)要求在文件頭部書(shū)寫(xiě)固定格式的注釋?zhuān)�如注明作者、協(xié)議等信息
5、文檔類(lèi)注釋?zhuān)翰糠忠?guī)定要求 API類(lèi)、函數(shù)等使用文檔類(lèi)注釋?zhuān)ㄈ?jsdoc 風(fēng)格）
6、遵循統(tǒng)一的風(fēng)格規(guī)范，如一定的空格、空行，以保證注釋自身的可讀性

三、代碼注釋怎么寫(xiě)

1、HTML代碼注釋?zhuān)?lt;!--注釋內(nèi)容 -->;

<!-- html中要注釋的內(nèi)容 -->
在web頁(yè)面中，最常見(jiàn)的注釋就是這種了。我們?cè)诓季猪?yè)面結(jié)構(gòu)的時(shí)候，會(huì)添加少許的注釋方便我們查找與記憶我們的想法。
那么在頁(yè)面中除了這樣的注釋外，還有那些注釋呢，這里我列舉一些：
If條件不同版本瀏覽器注釋列表：
<!--[if !IE]>除IE外都可識(shí)別<![endif]--> 
<!--[if IE]> 所有的IE可識(shí)別 <![endif]-->
<!--[if gt IE 5.0]> IE5.0以及IE5.0以上版本都可以識(shí)別 <![endif]--> 
<!--[if IE 6]> 僅IE6可識(shí)別 <![endif]--> 
<!--[if lt IE 6]> IE6以及IE6以下版本可識(shí)別 <![endif]--> 
<!--[if gte IE 6]> IE6以及IE6以上版本可識(shí)別 <![endif]--> 
<!--[if IE 7]> 僅IE7可識(shí)別 <![endif]--> 
<!--[if lt IE 7]> IE7以及IE7以下版本可識(shí)別 <![endif]--> 
<!--[if gte IE 7]> IE7以及IE7以上版本可識(shí)別 <![endif]-->

2、CSS代碼注釋 : /* 注釋內(nèi)容*/

與html中的注釋形式不同，css中的注釋采取的是/*css中的注釋*/的形式。注釋的內(nèi)容沒(méi)有單行多行之分。

/*.aa,.bb {
                height: 100px;
                margin: 1px;
                background: #ccc;
            }*/

3、JS代碼注釋 : //注 釋內(nèi)容; 或者/* 注釋內(nèi)容 */,

與html\css不同的是，js中的注釋存在單行多行的區(qū)分，也是種類(lèi)比較繁多下面就一一介紹。
（1） // 兩個(gè)斜杠表示單行注釋。
（2） <!-- 或者 <!-- --> 使用<!--或者<!-- --> 作為單行注釋.
（3）/* */ 多行注釋

//          function out(obj){
//              obj.innerHTML = "移出了";
//              obj.style.background = "#ccc";        
//          }

總結(jié)：前端開(kāi)發(fā)人員應(yīng)該深入理解代碼注釋的目的和原則，遵循注釋規(guī)約并結(jié)合工具使用，這樣才能使注釋成為代碼良好的輔助，增強(qiáng)可讀性和可維護(hù)性，從而提高代碼質(zhì)量。

以上就是前端開(kāi)發(fā)代碼注釋的作用及使用示范的詳細(xì)內(nèi)容，更多請(qǐng)關(guān)注php中文網(wǎng)其它相關(guān)文章！