注釋

1.注釋的定義

注釋的英文是annotation，是指對(duì)書籍或文章的語(yǔ)匯、內(nèi)容、背景、引文作介紹、評(píng)議的文字。

2.注釋的起源

注釋起源于先秦時(shí)期，在那個(gè)時(shí)候就有了對(duì)古書的注釋。

3.為什么要有注釋

注釋是為了對(duì)一些文字的解釋，一些不懂的事物的解釋。

注釋的對(duì)象不是自己，因?yàn)槟阕约簩懙臇|西自己肯定自己看的懂。關(guān)鍵在于雖然你看得懂，但是比人不一定看得懂。

就比如說(shuō)古書，你是看懂了，但是別人看不懂，這時(shí)候你就需要根據(jù)你自己的理解，對(duì)一些別人看不懂的地方進(jìn)行注釋。

再比如說(shuō)代碼。首先，代碼是你寫的吧，那你自己就是懂得咯。但是呢，別人看不懂怎么辦，你難不成跟每一個(gè)看不懂的人解釋一下這句話是干嘛的嗎？這里就需要注釋了，你注釋了，別人就能看懂了。但是注釋你也要盡量描述的清晰，不然就白注釋了。

4.注釋的原則

1）注釋形式統(tǒng)一

在整個(gè)應(yīng)用程序中，使用具有一致的標(biāo)點(diǎn)和結(jié)構(gòu)的樣式來(lái)構(gòu)造注釋。如果在其它項(xiàng)目中發(fā)現(xiàn)它們的注釋規(guī)范與這份文檔不同，按照這份規(guī)范寫代碼，不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。

2）注釋內(nèi)容準(zhǔn)確簡(jiǎn)潔

內(nèi)容要簡(jiǎn)單、明了、含義準(zhǔn)確，防止注釋的多義性，錯(cuò)誤的注釋不但無(wú)益反而有害。

6.注釋的快捷鍵

注釋的快捷鍵是“ctrl” + “/”兩個(gè)按鈕，這個(gè)是單行注釋。首先你需要選中你要注釋的內(nèi)容，然后先按“ctrl”，在按“/”，然后代碼就會(huì)被注釋了。 也可以是使用“ctrl” + “shift” ?+ “/”，這個(gè)是多行注釋。這里教你們一個(gè)方法，同時(shí)按三個(gè)的方法：你可以先按住“ctrl”鍵，然后再按“shift” ，最后在按“/”。

5.注釋的條件條件

一般來(lái)說(shuō)，我們不會(huì)無(wú)緣無(wú)故的注釋。因?yàn)槟菢硬粌H會(huì)增加我們的書寫量，而且也會(huì)把代碼變得不簡(jiǎn)潔。 基本注釋：全局變量的注釋、函數(shù)的注釋、鏈接的注釋、對(duì)象的注釋。 特殊注釋：在一些代碼不明處添加注釋。 下通同過(guò)案例說(shuō)明： <div class="header"><!--頭部--><div class="content"><!--內(nèi)容--><div class="logo"><!--logo--><img src="../img/logo.png" alt="logo圖片"/></div><div class="nav1"><!--導(dǎo)航欄--><ul><li><a href="index.html" target="_self">首頁(yè)</a></li><li><a href="download_app.html">app下載</a></li><li><a href="about.html">關(guān)于我們</a></li><li><a href="partner_apply.html">招商</a></li><li class="phone">400-1234-123</li></ul></div></div> </div><!--頭部-->
上面是一個(gè)HTML界面的編寫，他添加了好多注釋，讓我們一看就看的懂，好理解。
記住，一個(gè)不會(huì)注釋的碼農(nóng)不是一個(gè)好的程序員，一個(gè)沒有注釋的代碼塊不是一個(gè)好的代碼塊。

6.注釋分類

注釋有多種：

1）在HTML中的注釋：

格式是<!--內(nèi)容-->,內(nèi)容寫在中間，這個(gè)可以單行注釋，也可以是多行注釋。

<!--1.這是HTML中的單行注釋--> <!--2.這個(gè)是第二行-->

也可以這樣一起注釋，

<!--1.這個(gè)HTML中的多行注釋 2.這個(gè)是第二行-->

這樣都是可以實(shí)行注釋的。

2）在css中的注釋：

格式是/*內(nèi)容*/，內(nèi)容也是寫在中間，也是可以單行和多行注釋。

/*1.這個(gè)是在css中的單行注釋 2.這是第二行*/

/*1.這個(gè)是在css中的多行注釋*/ /*2.這是第二行*/

3)在js中的注釋：

這個(gè)js中的注釋比較特別，他有兩種格式：分別是單行注釋和多行注釋。單行和多行注釋使用的符號(hào)不一樣。

首先是單行注釋，這個(gè)注釋格式是//，兩個(gè)斜杠。代表的是該行斜杠后面的內(nèi)容被注釋了。

//1.這個(gè)是在js中的單行注釋 //2.這是第二行

下面是多行注釋，注釋格式與css一樣，使用的也是/*內(nèi)容*/形式。

/*1.這個(gè)是在js中的多行注釋 2.這是第二行*/

在java中注釋與js的注釋一樣，使用的方法也是相同的的。

7.注釋的特點(diǎn)

在代碼中注釋還有別的意義。他可以注釋你所寫的代碼，然后你注釋的代碼就不會(huì)執(zhí)行。
var sum = 0;sum+=1;sum+=2;/* sum+=3;sum+=4;*/sum+=5;alert(sum);
比如說(shuō)上面的代碼，他把中間兩行代碼注釋了。 沒注釋以前，sum是15,；注釋了以后sum是8. 這就證明了注釋了的代碼不會(huì)被執(zhí)行。
所以在代碼中注釋也是扮演一種很重要的角色，他既可以解釋代碼，也可以注釋代碼。

總結(jié)

注釋很重要！注釋很重要！注釋很重要！ 在代碼中盡量多寫注釋，要讓別人看的懂，但是也不要寫一些沒用的注釋。 當(dāng)你寫代碼的時(shí)候，你的注釋就是你與別人的交流語(yǔ)言，代表的是你的意思。

總結(jié)

以上是生活随笔為你收集整理的注释的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。