DWS系统开发编码规范

DWS系统开发编码规范

前言：

    通过建立代码编写规范，形成DWS 开发团队编码约定，提高程序的可靠性、可读性、可修改性、可维护性、一致性，保证程序代码的质量，继承软件开发成果，充分利用资源。提高程序的可继承性，使开发人员之间的工作成果可以共享。

软件编码要遵循以下原则:
1.遵循开发流程，在设计的指导下进行代码编写。
2.代码的编写以实现设计的功能和性能为目标，要求正确完成设计要求的功能，达到设计的性能。
3.程序具有良好的程序结构，提高程序的封装性好，减低程序的耦合程度。
4.程序可读性强，易于理解；方便调试和测试，可测试性好。
5.易于使用和维护；良好的修改性、扩充性；可重用性强/移植性好。
6.占用资源少，以低代价完成任务。
7.在不降低程序的可读性的情况下，尽量提高代码的执行效率。

本规范的描述主要以 Asp.net(C#) 语言为例

一、 规范：以下对本规范作详细说明。

1：源程序的文件管理：
b)命名：原程序文件命名采用有意义的格式。例如：对登陆程序来说是这样Login.aspx,每个程序文件由标题、内容和附加说明三部分组成。
  (A)标题：文件最前面的注释说明，其内容主要包括：程序名，作者，版本信息，简要说明等，必要时应有更详尽的说明（将以此部分以空行隔开单独注释）。
  (B)内容：为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现的顺序。类的定义按 private 、 protected 、 pubilic 的顺序，并尽量保持每一部分只有一个，各部分中按数据、函数、属性、事件的顺序。
  (C)附加说明：文件末尾的补充说明，如参考资料等，若内容不多也可放在标题部分的最后。