siebel实施规范-编码规范.pdf

Siebel 实施规范 ——编码规范 编写人: 张远舟 日 期：2010-7-5 目 录 Siebel 实施规范 – 编码规范(草稿) Hand 一、简介 1. 目的 本文的目的在于为汉得 Siebel 技术团队的编码规范提出意见和参考。 2. 适用范围 本规范（草稿）应用于 Siebel 实施项目中使用 E-Script 进行的编码的脚本开发。 二、编程规范 1. 总体规范 【规范1】优先考虑编码的可替代方案(User Property, Model State, Validation 等) 【规范2 】时刻考虑到你的每一个编码都会由其他的人在其他的时间使用、维护、增强 【规范3 】以不懂程序的人都能读懂你的代码为编码的最基本目标和要求 【规范4 】尽量使你的程序容易被调用（重用），修改和扩展 【规范5 】合理地捕获和处理异常 【规范5 】新创建的对象需要在代码结束时显式释放 【规范6 】效率是永远需要重点考虑、分析和优化的问题点 【规范7 】把相关的逻辑封装在BS 中，避免代码分散冗余，增加维护成本 2. 代码格式规范 【规范1】单行代码不得太长，需便于阅读，太长的代码行需要在适合的位置断行 【规范2 】每行代码最多包含一个独立的语句。 【规范3 】代码块之间使用Tab 缩进一次 【规范4 】一个方法的代码语句不宜过多，复杂的逻辑使用拆分成几个独立的Function 来实现，并确保一个 Function 只做一件独立的事情。 【规范5 】每一个变量的声明独占一行，变量的声明置于代码块开始位置。 【规范6 】在逻辑块、代码块之间合理使用单个空行 3．代码注释规范 【规范1】适当地编写代码注释，增强代码的可读性和可维护性 说明：一般情况下，程序或 Function 的作用，参数，创建和修改信息等都需要通 过注释来标识，便以使用、维护和管理。程序中的逻辑块、复杂算法、重要变量的意 义等也需要用注释来说明。 【规范2】在修改代码的同时，修改代码注释。 说明：代码被修改后，必须同步修改代码注释，已实现注释的正确指导意义。代 码频繁被改动但注释不变是容易导致歧义的根源之一。 【规范3】注释必须有但是不能过度。 并不需要为每一句代码、每一个变量使用一句注释，这样反而使得代码变得冗长 汉得 Siebel 事业部 第 1 页 共 15 页 Siebel 实施规范 – 编码规范(草稿) Hand 累赘而不易维护。一般只在关键点使用注释。 【规范4】方法注释规范。 方法注释用于说明方法文件的一些基本信息，包括方法的作用，参数，返回值， 创 建 者 和 创 建 日 期 ， 更 新 者 和 更 新 日 期 ， 代 码 版 本 等 。 如 对 Function SubmitOrder(orderId)注释如下： /* * Function: To Set The Status of The Specified Order to Be ‘Submitted’ * @Param1 orderId: The Id Value of The Specified Order * @Return: true if success, otherwise false * Author：Neo.Zhang * Created： 6/10/2010 * Last Updated By：Neo.Zhang * Last Updated: 7/5/2010 * Modifications: * 1. Add Validation to Make Sure Order Type Is Purcha