Delphi_编码指南编码规范.ppt

D编码指南编码规范 技术规划部 WWW.SERVYOU.COM.CN 课程目标 提高编码人员的规范意识以及规范的重要性 了解公司编码规范的内容 理解编码规范和编码指南的区别 利用编码指南少犯错 了解编码指南的作用和内容 WWW.SERVYOU.COM.CN 主要内容 为什么需要编码规范和指南（讨论） 公司编码规范中的主要内容介绍 常见错误分析 编码指南和编码规范的区别 编码指南中主要内容介绍 如何使用该指南 WWW.SERVYOU.COM.CN 为什么需要编码规范和指南？（讨论） WWW.SERVYOU.COM.CN 一些编码工程师的态度： 别人看不懂的程序才是高明的程序。 编写程序，完成功能是最主要的，规范无所谓的。 规范这些东西完全没有必要，在编码完成后最后检查一下就可以了。 项目时间这么紧张，没有时间搞这个。 。。。 WWW.SERVYOU.COM.CN 为什么要有编码规范和指南？ 一个软件的生命周期中，80%的花费在于维护 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 规范和指南中记录了很多前人犯过的错误 WWW.SERVYOU.COM.CN 编码规范和指南的目的（总结1） 让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 为了使开发小组能够在编码过程中遵循一致的风格，代码阅读者能够看懂各个成员编写的代码 所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适 应，但是在多个开发人员 共同写作的情况下，这些规则是必需的。这不仅仅是为了开 发效率来考虑，而且也是为了后期维护考虑。 ………………………… WWW.SERVYOU.COM.CN 编码规范和指南的目的（总结2） 创建这样的程序代码: 易理解 易维护 正确的 格式规范，风格统一 WWW.SERVYOU.COM.CN 编码规范和指南的目的（总结3） 阅读代码的时间比写代码的时间多得多 思路清晰的设计可获得易于理解的程序，但注释、细致的解释以及一些示例往往具有不可估量的价值，无论对编码者自己，还是对同事，它们都是相当重要的 前车之鉴，后事之师 WWW.SERVYOU.COM.CN 公司编码规范中的主要内容 ： 文件规范 命名规范 排版和格式 注释 编程约束和技巧 WWW.SERVYOU.COM.CN 公司编码规范中的主要内容 ： 编码规范： Delphi编码规范 Java编码规范 其他规范: J2EE项目开发命名标准 SQL(数据库)编码规范 WWW.SERVYOU.COM.CN 常见错误分析 ： 评审中发现问题做多的编码规范问题： １、注释问题 ２、变量命名规范问题 ３、规范中提到的约束没有遵守，比如DAO架构中不再推荐继续ARRAYLIST的形式 ４、异常处理的写法是否完整、规范 ５、。。。 WWW.SERVYOU.COM.CN 编码指南和编码规范的区别 编码规范是公司级的，编码指南是项目级的。 为什么是项目级的？今天所培训的只是一模板，每个项目根据该模板要求制定出符合本项目的编码指南文档 编码规范是基础，编码指南基于编码规范 编码指南内容不只是编码规范类，还有更多项目级个性化的东西： 提示信息如何统一提示？ 界面上的约束是如何规定的？ 。。。。 WWW.SERVYOU.COM.CN 指南对项目的作用 统一对项目中编码进行约束和指导 对概要设计和详细设计的补充 测试时的一个依据 经验教训共享。 常见错误的集中定义和在项目进展过程中随时增加发布給每个编码人员。 通用的处理机制： 统一的提示机制、日志记录、常量、公共函数、基础代码表等等的处理方法 WWW.SERVYOU.COM.CN 编码指南中主要内容介绍 开发框架 命名补充约定 界面编码约束 提示信息 日志使用 常量 公共函数 基础代码表 常见错误 WWW.SERVYOU.COM.CN 开发框架 开发架构图 项目组允许使用的组件 项目开发流程说明 开发环境介绍 WWW.SERVYOU.COM.CN 命名补充约定 模块对照表 项目文件目录结构 配置文件命名约定 WWW.SERVYOU.COM.CN 界面编码约束 输入框设计约定 界面操作约定 WWW.SERVYOU.COM.CN 提示信息 项目中所有需要提示給用户的信息统一该以下处理 如何配置？ 提示信息配置文件格式？ 代码中如何调用？ WWW.SERVYOU.COM.CN 日志使用 规定对后台日志的记载方法，项目都采用统一的规