项目代码开发规范.docxVIP

文档版本修改记录日期作者版本变更说明V0.1初稿审核记录版本审核人职务审核日期目录1概述71.1目的71.2术语81.3命名规则81.3.1Pascal?大小写81.3.2Camel?大小写91.3.3匈牙利命名法92通用编程规范92.1明确性和一致性92.2格式和风格92.3库的使用92.4静态字段(全局变量)102.5变量的声明和初始化102.6函数的声明和调用112.7代码语句122.8空格132.8.1空行132.8.2空格142.9大括号142.10注释162.10.1内联代码注释172.10.2类注释202.10.3函数注释212.10.4TODO 待办注释222.11代码块223.Net编程规范223.1类库开发设计规范223.2文件和结构233.3命名规范233.3.1综合命名规范233.3.2标识符的大小写命名规范233.3.3户界面控件命名规范263.4常量273.5字符串283.6枚举303.6.1标志枚举323.7数组和集合353.8结构体383.9类393.9.1字段393.9.2属性393.9.3构造函数393.9.4方法403.9.5事件403.9.6成员方法重载403.9.7接口成员413.9.8虚成员方法413.9.9静态类423.9.10抽象类423.10错误和异常433.10.1抛出异常433.10.2异常处理443.11资源清理463.11.1Try-finally 块473.11.2基础Dispose 模式483.11.3可终结类型523.11.4重写 Dispose574数据库编程规范594.1基本原则594.2SQL编程规范594.2.1大小写594.2.2使用“;”594.2.3类型选择604.2.4默认值604.2.5字段长度604.2.6使用“”604.2.7语句缩进604.2.8语句换行614.2.9语句分割614.2.10使用“*”614.2.11表名别名614.2.12类型转换624.2.13数值比较624.2.14排序624.2.15BEGIN...END?块624.2.16TRY块624.2.17TRANSACTION编写634.2.18存储过程644.2.19代码注释645HTMLJavaScript编程规范655.1HTML规范655.1.1标签书写655.1.2标签缩进665.1.3注释675.1.4界面控件命名规范675.2JavaScript编程规范685.2.1程序文件685.2.2变量685.2.3函数695.2.4{ } 和 [ ]696项目规范696.1基本技术框架696.2设计与命名规范706.2.1开发解决方案结构规范706.2.2Namespace716.2.3UI层716.2.4业务逻辑层736.2.5数据访问层756.2.6数据库756.3框架工程消费调用规范766.3.1业务实体持久层调用规范766.3.2业务组件调用规范776.4开发安全规范776.4.1UI规范77概述目的本规范定义本项目在开发工作中必须遵循的工作规范。目的在于帮助项目开发者提高开发效率，减少代码中可能出现的bug，并增强代码的可维护性。万事开头难，采纳一个不熟悉的规范可能在初期会有一些棘手和困扰，但是这些不适应很快便会消失，它所带来的好处和优势很快便会显现，特别是在当您接手他人代码时。高质量的代码示例往往具有如下特质:易懂– 代码示例必须易读且简单明确。它们必须能展示出重点所在。示例代码的相关部分应当易于重用。示例代码不可包含多余代码。它们必须带有相应文档说明。正确性– 示例代码必须正确展示出其欲告知使用者的重点。代码必须经过测试，且可以按照文档描述进行编译和运行。一致性 – 示例代码应该按照一致的编程风格和设计来保证代码易读。同样的，不同代码示例之间也应当保持一致的风格和设计，使使用者能够很轻松的结合使用它们。流行性 – 代码示例应当展示现行的编程实践，例如使用 Unicode，错误处理，防御式编程以及可移植性。示例代码应当使用当前推荐的运行时库和API函数，以及推荐的项目和生成设置。可靠性 – 代码示例必须符合法律，隐私和政策标准和规范。不允许展示入侵性或低质的编程实践，不允许永久改变机器状态。所有的安装和执行过程必须可以被撤销。安全性 - 示例代码应该展示如何使用安全的编程实践：例如最低权限原则，使用运行时库函数的安全版本，以及SDL推荐的项目设置。合理使用编程实践，设计和语言特性决定了示例代码是否可以很好满足上述特性。本编程规范致力于帮助您创建代码示例以使使用者能够作为最佳实践来效仿和学习。术语在整个文档中，会有一些对于标准和实践的推荐和建议。一些实践是非常重要的，必须严格执行，另一些指导准则并不一定处处适用，但是会在特定的场景下带来益处。为了清楚陈述规