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  在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。
……

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