Siebel实施规范-编码规范.doc

《Siebel实施规范-编码规范.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、Siebel实施规范——编码规范编写人:张远舟日期：2010-7-5目录一、简介11.目的12.适用范围1二、编程规范11.总体规范12.代码格式规范13．代码注释规范14.命名规范35.逻辑稳定规范45.性能效率规范4三、代码Review规范51.代码Review的目的52.代码Review方法53.代码Review规范5一、简介1.目的本文的目的在于为汉得Siebel技术团队的编码规范提出意见和参考。2.适用范围本规范（草稿）应用于Siebel实施项目中使用E-Script进行的编码的脚本开发。二、编程规范1.总体规范【规范1】优先考虑编码的可替代方案(UserProperty,

2、ModelState,Validation等)【规范2】时刻考虑到你的每一个编码都会由其他的人在其他的时间使用、维护、增强【规范3】以不懂程序的人都能读懂你的代码为编码的最基本目标和要求【规范4】尽量使你的程序容易被调用（重用），修改和扩展【规范5】合理地捕获和处理异常【规范5】新创建的对象需要在代码结束时显式释放【规范6】效率是永远需要重点考虑、分析和优化的问题点【规范7】把相关的逻辑封装在BS中，避免代码分散冗余，增加维护成本2.代码格式规范【规范1】单行代码不得太长，需便于阅读，太长的代码行需要在适合的位置断行【规范2】每行代码最多包含一个独立的语句。【规范3】代码块之间使用T

3、ab缩进一次【规范4】一个方法的代码语句不宜过多，复杂的逻辑使用拆分成几个独立的Function来实现，并确保一个Function只做一件独立的事情。【规范5】每一个变量的声明独占一行，变量的声明置于代码块开始位置。【规范6】在逻辑块、代码块之间合理使用单个空行3．代码注释规范【规范1】适当地编写代码注释，增强代码的可读性和可维护性说明：一般情况下，程序或Function的作用，参数，创建和修改信息等都需要通过注释来标识，便以使用、维护和管理。程序中的逻辑块、复杂算法、重要变量的意义等也需要用注释来说明。【规范2】在修改代码的同时，修改代码注释。说明：代码被修改后，必须同步修改代码注

4、释，已实现注释的正确指导意义。代码频繁被改动但注释不变是容易导致歧义的根源之一。【规范3】注释必须有但是不能过度。并不需要为每一句代码、每一个变量使用一句注释，这样反而使得代码变得冗长累赘而不易维护。一般只在关键点使用注释。【规范4】方法注释规范。方法注释用于说明方法文件的一些基本信息，包括方法的作用，参数，返回值，创建者和创建日期，更新者和更新日期，代码版本等。如对FunctionSubmitOrder(orderId)注释如下：/Function:ToSetTheStatusofTheSpecifiedOrdertoBe‘Submitted’@Param1orderId:TheI

5、dValueofTheSpecifiedOrder@Return:trueifsuccess,otherwisefalseAuthor：Neo.ZhangCreated：6/10/2010LastUpdatedBy：Neo.ZhangLastUpdated:7/5/2010Modifications:1.AddValidationtoMakeSureOrderTypeIsPurchaseOrderon6/12/2010ByNeo.Zhang2.CommentedtheCodeBlockofPurchaseHistoryAccumulationon7/5/2010ByNeo.Zhang

6、Version:1.2/注释可根据项目环境选择使用中文或英文。【规范5】变量注释规范以下情况，变量需要使用注释：1.常量，尤其是业务常量2.采用了不容易被理解的缩写作为变量名的变量3.程序逻辑中重要的核心变量4.作为方法返回值的变量5.变量注释的格式为在变量声明的上一行使用//注释如://ADictionaryArraytoStoreOrderQuantityofProductIdvaraProdQty=[];【规范6】不要编写修饰性的注释。不要使用类似以下的注释。因为脚本具有最大字节数限制，这样的注释将占用大量字节数，且显得累赘多余。/ThisCodeBlockDealsWitht

7、heRMABusiness/【规范7】在具有复杂算法或复杂逻辑的代码块前，说明其算法或逻辑。例如：/以下的代码用于计算维修店计划建议表数据，具体逻辑是……/【规范8】对于临时代码或弃用代码，需要注释掉并说明注释原因，不可直接删除。临时代码是指现在不使用，但是将来有可能被启用的代码。弃用代码是指原来使用，但是现在不再使用的代码。对于这样的代码，我们通常使用//把它们注释起来，并在代码块上一行说明注释原因，如：临时代码注释说明：//修改SO行数量时，连带修改相