研发代码编程规约.doc_第1页
研发代码编程规约.doc_第2页
研发代码编程规约.doc_第3页
研发代码编程规约.doc_第4页
研发代码编程规约.doc_第5页
全文预览已结束

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

研发代码编程规约一、数据库连接规范1. 使用Trycatchfinally，在使用完一个链接后务必关闭它（在finally块中关闭）；2. 使用using释放资源；3. 尽量减少配置文件的个数；4. 开发采用三层或以上结构，及表现层、逻辑层、数据层，避免使用数据库直连方式操作数据库；5. 建立独立的数据库操作类，所有数据库连接、事务等操作使用此独立的数据库操作类。二、注释规范注释应该增加代码的清晰度；保持注释的简洁，不是任何代码都需要注释的，过多的注释反而会影响代码的可读性；注释不应该包括其他的特殊字符；先写注释，后写代码；注释规范包括：模块类接口注释规范、类的属性、方法注释规范。1、模块类接口注释规范模块类接口开始必须以以下形式书写模块注释：/作用&目的：/作者：作者中文名/编写日期：/如果模块类有修改，则每次修改必须添加以下注释：/Log编号：/修改描述：/作者：修改者中文名/修改日期：/2、类属性注释规范在类的属性必须以以下格式编写属性注释：/属性说明/3、方法注释规范在类的方法声明前以以下格式编写注释：/说明：/paramname=/注：公有方法必须按照以上格式注释，私有方法也可用双反斜杠做简要注释。三、错误处理和日志记录不要“捕捉了异常却什么也不做”。发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。别写太大的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 出错类：perty:(null) 错误描述：发生了一个异常X
人人文库> 全部分类> 行业资料 > 管理策划

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论