Capb編碼規範(doc 26頁)

1、概述
2、注釋生成XML文檔
3、代碼注釋
4、命名規範
5、約定

1概述
1.1規範製定原則
1 方便代碼的交流和維護。
2 不影響編碼的效率，不與大眾習慣衝突。
3 使代碼更美觀、閱讀更方便。
4 使代碼的邏輯更清晰、更易於理解。
1.2術語定義
1.2.1Pascal 大小寫
將標識符的首字母和後麵連接的每個單詞的首字母都大寫。可以對三字符或更多字符的標識符使用Pascal 大小寫，文件命名也采用Pascal 大小寫。例如：
BackColor.cs
1.2.2Camel 大小寫
標識符的首字母小寫，而每個後麵連接的單詞的首字母都大寫。例如：
backColor
2注釋生成XML文檔
2.1注釋概述
1 修改代碼時，總是使代碼周圍的注釋保持最新。
2 在每個例程的開始，提供標準的注釋樣本以指示例程的用途、假設和限製很有幫助。注釋樣本應該是解釋它為什麼存在和可以做什麼的簡短介紹。
3 避免在代碼行的末尾添加注釋；行尾注釋使代碼更難閱讀。不過在批注變量聲明時，行尾注釋是合適的；在這種情況下，將所有行尾注釋在公共製表位處對齊。
4 避免雜亂的注釋，如一整行星號。而是應該使用空白將注釋同代碼分開。
5 避免在塊注釋的周圍加上印刷框。這樣看起來可能很漂亮，但是難於維護。
6 在部署發布之前，移除所有臨時或無關的注釋，以避免在日後的維護工作中產生混亂。
……

..............................