您好,登錄后才能下訂單哦!
今天就跟大家聊聊有關(guān)前端開發(fā)代碼如何注釋,可能很多人都不太了解,為了讓大家更加了解,小編給大家總結(jié)了以下內(nèi)容,希望大家根據(jù)這篇文章可以有所收獲。
一、代碼注釋有什么用
1、和偽代碼一樣的作用,為接下來要實(shí)現(xiàn)的功能寫出一個(gè)指導(dǎo)性的算法思路。只是沒有偽代碼詳細(xì)。但是也指出了完成此功能的大體算法思路。
2、給看代碼的人一個(gè)解釋性說明。注意看代碼的人包括你自己。讓看你代碼的人可以快速的瀏覽你的代碼,不至于每看一行都要一行一行的看下去,才能明白你寫的什么。
二、代碼注釋規(guī)范,遵循以下原則
1、能夠幫助讀者更好的了解代碼邏輯與結(jié)構(gòu)
2、特別的或不容易理解的寫法可以解釋說明
3、特殊標(biāo)記注釋:如 TODO、FIXME 等有特殊含義的標(biāo)記
4、文件注釋:部分規(guī)定會(huì)要求在文件頭部書寫固定格式的注釋,如注明作者、協(xié)議等信息
5、文檔類注釋:部分規(guī)定要求 API類、函數(shù)等使用文檔類注釋(如 jsdoc 風(fēng)格)
6、遵循統(tǒng)一的風(fēng)格規(guī)范,如一定的空格、空行,以保證注釋自身的可讀性
三、代碼注釋怎么寫
1、HTML代碼注釋:<!--注釋內(nèi)容 -->;
<!-- html中要注釋的內(nèi)容 --> 在web頁(yè)面中,最常見的注釋就是這種了。我們?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)容沒有單行多行之分。
/*.aa,.bb { height: 100px; margin: 1px; background: #ccc; }*/
3、JS代碼注釋 : //注 釋內(nèi)容; 或者/* 注釋內(nèi)容 */,
與html\css不同的是,js中的注釋存在單行多行的區(qū)分,也是種類比較繁多下面就一一介紹。
(1) // 兩個(gè)斜杠表示單行注釋。
(2) <!-- 或者 <!-- --> 使用<!--或者<!-- --> 作為單行注釋.
(3)/* */ 多行注釋
// function out(obj){ // obj.innerHTML = "移出了"; // obj.style.background = "#ccc"; // }
看完上述內(nèi)容,你們對(duì)前端開發(fā)代碼如何注釋有進(jìn)一步的了解嗎?如果還想了解更多知識(shí)或者相關(guān)內(nèi)容,請(qǐng)關(guān)注億速云行業(yè)資訊頻道,感謝大家的支持。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。