源程序书写规范.pdfVIP

源程序书写规范 命名 对于理解应用程序的逻辑流，命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是 “如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象 层。例如，可以使用 GetNextStudent()，而不是 GetNextArrayElement()。 命名原则是：选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以 便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的 名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名 称符合适用语言的规则和标准。 以下几点是推荐的命名方法。 Namespace 名 1. 使用 Pascal case 命名。 2. 使用 公司名.产品名 这样的格式。当商标（产品名）的命名风格和 Pascal case 不相 符的时候，以商标（产品名）为准。 3. Namespace中类的依赖关系应该体现在命名上，比如System.Web.UI.Design中的类以来 于 System.Web.UI。 4. 在语意合适的情况下使用复数，比如 System.Collections。例外是缩写和商标的情况。 5. Namespace的名字不一定和 Assembly一一对应。 类名 1. 文件名要和类名匹配。例如，对于类HelloWorld, 相应的文件名应为 helloworld.cs (或, helloworld.vb) 2. 3. 枚举名称不要加 Enum 前缀或者后缀。枚举名用单数形式，不要用复数形式。枚举的成 员使用Pascal 命名。 仅仅在这个Enum类型是 bit fields地时候使用复数形式，并且总是给bit field Enum 类型添加 FlagsAttribute。 4. 接口名加I 前缀，接口的成员使用Pascal 命名。 5. 事件，委派 如果delegate 用来定义事件，加EventHandler 后缀。 如果delegate 用来定义 callback方法，加 Callback 后缀（实际的callback 方法不要 加 Callback后缀）。 用动词命名事件，不要加Event 后缀或者前缀。不要在事件声明中使用前缀和后缀，比 如，用 Close而不是OnClose。用 ing和ed 后缀来表示先后概念，不要用before，after， begin，end模式。 一般的，你应该同时提供一个名字为 OnXxx 的protected method供派生类来改写 6. 使用特定的设计模式（包括但不限于 GoF的 23种模式）时使用适当类名称表明类在该 模式中的功能职责。 7. 类名中不使用C 前缀。比如 CWindow。 8. 使用后缀的形式指明在设计上具备某种作用的类，如： Exception类类名加Exception 后缀：WordWordException 组件类：WordWordBean 组件中的值类型：WordWordBeanInfo 适配器：WordWordAdapter Attribute类类名加Attribute 后缀：WordWordAttribute。 在 MiniDAC 中，常使用的类名后缀：-Dac, -Info, -Utility。 另外,后缀Class有助于避免和已有的命名冲突：WordWordClass 9. 对于特定用途的专业应用的类库可使用统一的前缀，前缀可以是用途名也可以是公司 名，格式为WrdWordWord, 如用于图形平台的所有类以 Cad 开头，如 CadLine, CadCircle 等。 10. 测试类的命名使用Test 前缀。 例程（方法、函数） 1. 避免容易被主观解释的难懂的名称，如对于例程的 AnalyzeThis()，或者对于变量的 xxK8。这样的名称会导致多义性，而不仅仅是抽象。