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

一、代碼注釋有什么用

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

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

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

三、代碼注釋怎么寫

1、HTML代碼注釋：<!--注釋內(nèi)容 -->;

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

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

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

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

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

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

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

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

聲明：本網(wǎng)頁內(nèi)容旨在傳播知識，若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com