代碼注釋

1.注釋要簡單明了。

2.邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一緻性。

3.在必要的地方注釋，注釋量要适中。注釋的内容要清楚、明了，含義準确，防止注釋二義性。保持注釋與其描述的代碼相鄰，即注釋的就近原則。

4.對代碼的注釋應放在其上方相鄰位置，不可放在下面。

5.對數據結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋應放在此域的右方；同一結構中不同域的注釋要對齊。

6.變量、常量的注釋應放在其上方相鄰位置或右方。

7.全局變量要有較詳細的注釋，包括對其功能、取值範圍、哪些函數或過程存取它以及存取時注意事項等的說明。

8.在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本号；作者；生成日期；模塊功能描述（如功能、主要算法、内部各部分之間的關系、該文件與其它文件關系等）；主要函數或過程清單及本文件曆史修改記錄等。

9.在每個函數或過程的前面要有必要的注釋信息，包括：函數或過程名稱；功能描述；輸入、輸出及返回值說明；調用關系及被調用關系說明等。