研发代码编程规约.docVIP

研发代码编程规约 一、数据库连接规范 使用Try……catch……finally，在使用完一个链接后务必关闭它（在finally块中关闭）； 使用using释放资源； 尽量减少配置文件的个数； 开发采用三层或以上结构，及表现层、逻辑层、数据层，避免使用数据库直连方式操作数据库； 建立独立的数据库操作类，所有数据库连接、事务等操作使用此独立的数据库操作类。 二、注释规范 注释应该增加代码的清晰度；保持注释的简洁，不是任何代码都需要注释的，过多的注释反而会影响代码的可读性；注释不应该包括其他的特殊字符；先写注释，后写代码； 注释规范包括：模块\类\接口注释规范、类的属性、方法注释规范。 1、模块\类\接口注释规范 模块\类\接口开始必须以以下形式书写模块注释： ///summary ///作用目的：对此类的描述，可以引用系统设计中的描述 ///作者：作者中文名 ///编写日期：模块创建日期，格式：YYYY-MM-DD ////summary 如果模块\类有修改，则每次修改必须添加以下注释： ///summary ///Log编号：Log编号,从1开始一次增加 ///修改描述：对此修改的描述 ///作者：修改者中文名 ///修改日期：模块修改日期，格式：YYYY-MM-DD ////summary 2、类属性注释规范 在类的属性必须以以下格式编写属性注释： ///summary ///属性说明 ////summary 3、方法注释规范 在类的方法声明前以以下格式编写注释： ///summary ///说明：对该方法的说明 ////summary ///paramname=参数名称参数说明/param ///returns ///对方法返回值的说明，该说明必须明确说明返回的值代表什么含义 ////returns 注：公有方法必须按照以上格式注释，私有方法也可用双反斜杠做简要注释。 三、错误处理和日志记录 不要“捕捉了异常却什么也不做”。发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。 别写太大的try-catch模块。如果需要，为每个执行的任务编写单独的try-catch模块。 1、日志类型 主要分三大类： 安全类信息：记录系统边界交互行为和信息 业务类信息：记录系统内部业务处理行为和信息 性能类信息：记录系统硬件对业务处理的支撑能力 2、日志级别 ERROR（错误）：此级别记录影响主体系统核心模块正常工作，需要修复才能正常工作的问题。 WARN（警告）：此级别记录系统一般模块存在问题，不影响系统运行。包括记录普通的异常抛出。 INFO （通知）：此级别主要是记录系统运行状态等关联信息。包括服务启动、服务停止、用户登录、退出、权限更改、用户操作申请等信息。 DEBUG（调试）：最细粒度的级别记录，除却上面各种情况后，希望输出的相关信息，都可以在这里输出。 3、日志记录准则 记录ERROR、WARN及INFO级别的日志，在日志文件前加入项目名称前缀缩写，如“Application_error.log”。DEBUG级别日志在试运行阶段需监控系统各种操作时可加入记录。 日志记录使用开源组件，从common.logging，Nlog或Log4net三个日志组件中择其一。 建议使用配置文件定义日志输出目录、日志名称、日志输出级别等信息。 以电子病历为主的依附产品及功能模块，日志文件放入电子病历根目录；其它独立产品可放入该产品独立目录。 日志内容格式建议： 记录时间：yyyy-MM-dd HH:mm:ss 记录等级：[ERROR] 出错类：mainclass.property:[(null)] – 错误描述：发生了一个异常XXXX 四、评审检查 每月进行一次代码检查，主要是抽查各产品组代码中的注释，进行评审。 数据库连接数及日志记录规范以测试为主导进行审查。