注釋的作用：

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

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

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

4.說明函數(shù)的使用場景

5.作者和日期

6.說明變量的作用

7.函數(shù)調用方法與注意事項

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

所以寫代碼需其實注釋沒有特別嚴格的注釋格式，但是為了使得注釋整齊簡潔。還是會有一些格式的要求的。針對不同開發(fā)平臺，不同編程語言，都有各自不同的注釋推薦格式。

命名基本原則

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

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

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

(4)同一軟件產品內模塊之間接口部分的標識符名稱之前加上模塊標識。

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

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

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

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

一個文件包含一類功能或一個模塊的所有函數(shù)，文件名稱應清楚表明其功能或性質。每個.c文件應該有一個同名的.h文件作為頭文件。

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

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

文件名稱：

作者：

版本：

說明：

修改記錄：

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

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

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

函數(shù)名稱：

函數(shù)功能：

入口參數(shù)：

出口參數(shù)：

備注：

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

注釋加深對程序的理解。如果能夠對程序中每句話加上正確合理的注釋，那么說明對程序的掌握是很到位的。尤其是在自己編寫程序時、或者抄別人程序時，難免會出現(xiàn)語法錯誤和現(xiàn)象不符，這時如果能夠對每句話加以注釋，就能大大加深對程序的理解，也能更快的找到問題所在。試想，對程序中的每句話都加上了清晰明了的注釋，還會看不懂程序嗎。在注釋過程中，在哪里卡住了，或者無法做出合理的解釋，那么很有可能這就是問題所在。

便于以后回看。人的記憶是有限的，一段沒有注釋的程序在閑置一段時間后，再次看時，可能會看不懂程序寫的說什么意思。這時詳細的注釋就像是產品說明書，配合著注釋，能夠在短時間內明白程序所寫的含義。