注釋對(duì)于我們寫(xiě)代碼的一些重要性

注釋的作用：

1.說(shuō)明函數(shù)的功能

2.說(shuō)明函數(shù)參數(shù)的意思

3.說(shuō)明函數(shù)這樣設(shè)計(jì)的原理（計(jì)算公式）

4.說(shuō)明函數(shù)的使用場(chǎng)景

5.作者和日期

6.說(shuō)明變量的作用

7.函數(shù)調(diào)用方法與注意事項(xiàng)

要注釋是多么重要的一件事情啊。

所以寫(xiě)代碼需其實(shí)注釋沒(méi)有特別嚴(yán)格的注釋格式，但是為了使得注釋整齊簡(jiǎn)潔。還是會(huì)有一些格式的要求的。針對(duì)不同開(kāi)發(fā)平臺(tái)，不同編程語(yǔ)言，都有各自不同的注釋推薦格式。

命名基本原則

(1)命名清晰明了，有明確含義，使用完整單詞或約定俗成的縮寫(xiě)。通常，較短的單詞可通過(guò)去掉元音字母形成縮寫(xiě)；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫(xiě)。即"見(jiàn)名知意"。

(2)命名風(fēng)格要自始至終保持一致。

(3)命名中若使用特殊約定或縮寫(xiě)，要有注釋說(shuō)明。

(4)同一軟件產(chǎn)品內(nèi)模塊之間接口部分的標(biāo)識(shí)符名稱(chēng)之前加上模塊標(biāo)識(shí)。

宏和常量用全部大寫(xiě)字母來(lái)命名，詞與詞之間用下劃線分隔。對(duì)程序中用到的數(shù)字均應(yīng)用有意義的枚舉或宏來(lái)代替。

變量名用小寫(xiě)字母命名，每個(gè)詞的第一個(gè)字母大寫(xiě)。類(lèi)型前綴(u8s8 etc.)全局變量另加前綴g_。

局部變量應(yīng)簡(jiǎn)明扼要。局部循環(huán)體控制變量?jī)?yōu)先使用i、j、k等；局部長(zhǎng)度變量?jī)?yōu)先使用len、num等；臨時(shí)中間變量?jī)?yōu)先使用temp、tmp等。

函數(shù)名用小寫(xiě)字母命名，每個(gè)詞的第一個(gè)字母大寫(xiě)，并將模塊標(biāo)識(shí)加在最前面。

一個(gè)文件包含一類(lèi)功能或一個(gè)模塊的所有函數(shù)，文件名稱(chēng)應(yīng)清楚表明其功能或性質(zhì)。每個(gè).c文件應(yīng)該有一個(gè)同名的.h文件作為頭文件。

文件注釋必須說(shuō)明文件名、函數(shù)功能、創(chuàng)建人、創(chuàng)建日期、版本信息等相關(guān)信息。修改文件代碼時(shí)，應(yīng)在文件注釋中記錄修改日期、修改人員，并簡(jiǎn)要說(shuō)明此次修改的目的。所有修改記錄必須保持完整。文件注釋放在文件頂端，用"/*……*/"格式包含。注釋文本每行縮進(jìn)4個(gè)空格；每個(gè)注釋文本分項(xiàng)名稱(chēng)應(yīng)對(duì)齊。

/***********************************************************

文件名稱(chēng)：

作者：

版本：

說(shuō)明：

修改記錄：

***********************************************************/

函數(shù)頭部注釋?xiě)?yīng)包括函數(shù)名稱(chēng)、函數(shù)功能、入口參數(shù)、出口參數(shù)等內(nèi)容。如有必要還可增加作者、創(chuàng)建日期、修改記錄(備注)等相關(guān)項(xiàng)目。函數(shù)頭部注釋放在每個(gè)函數(shù)的頂端，用"/*……*/"的格式包含。其中函數(shù)名稱(chēng)應(yīng)簡(jiǎn)寫(xiě)為Name()，不加入、出口參數(shù)等信息。

/***********************************************************

函數(shù)名稱(chēng)：

函數(shù)功能：

入口參數(shù)：

出口參數(shù)：

備注：

***********************************************************/

注釋加深對(duì)程序的理解。如果能夠?qū)Τ绦蛑忻烤湓?huà)加上正確合理的注釋?zhuān)敲凑f(shuō)明對(duì)程序的掌握是很到位的。尤其是在自己編寫(xiě)程序時(shí)、或者抄別人程序時(shí)，難免會(huì)出現(xiàn)語(yǔ)法錯(cuò)誤和現(xiàn)象不符，這時(shí)如果能夠?qū)γ烤湓?huà)加以注釋?zhuān)湍艽蟠蠹由顚?duì)程序的理解，也能更快的找到問(wèn)題所在。試想，對(duì)程序中的每句話(huà)都加上了清晰明了的注釋?zhuān)€會(huì)看不懂程序嗎。在注釋過(guò)程中，在哪里卡住了，或者無(wú)法做出合理的解釋?zhuān)敲春苡锌赡苓@就是問(wèn)題所在。

便于以后回看。人的記憶是有限的，一段沒(méi)有注釋的程序在閑置一段時(shí)間后，再次看時(shí)，可能會(huì)看不懂程序?qū)懙恼f(shuō)什么意思。這時(shí)詳細(xì)的注釋就像是產(chǎn)品說(shuō)明書(shū)，配合著注釋?zhuān)軌蛟诙虝r(shí)間內(nèi)明白程序所寫(xiě)的含義。