1.1註釋與命名規則

註釋通常用於:

1、版本、版權聲明;

2、函數接口聲明;

3、重要代碼行提示

添加註釋的注意事項:

1、註釋量一般佔代碼量的40%;

2、註釋放在代碼上方或右方;

3、函數定義前加一個合適的函數頭,說明該函數的功能、參數、返回值等

4、邊寫代碼邊寫註釋,保證註釋與代碼的一致性,修改代碼時必須同時修改註釋,沒用的註釋刪除;

5、避免在註釋中使用縮寫;

6、代碼比較長時,尤其是有多重嵌套時,應當在一些段落結束處加註釋,以便於閱讀。

 

 

 

Microsoft程序員Charles Simonyi的“匈牙利”命名法:

1、望文生義

通常前綴g_表示全局變量,m_表示成員變量,s_表示靜態變量,p表示指針等

2、避免標識符過長

3、避免歧義,避免使用靠大小寫區分的標識符,也不要在不同作用域使用相同名字的標識符

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章