Siebｅl实施规范——编码规范编写人:张远舟日期:２０10-7-5目录TＯＣ\ｏ"1-3"\h\ｚ＼uHYPERLＩNK＼l"_Toc26631768１"一、简介ﻩＰAGＥREＦ_Toc266317681\h1HＹPＥRLINK\l"_Tｏc266317６82"1、目得PAGERＥF_Ｔoc266317６８2\ｈ１HYＰＥRLＩNK\l"_Ｔoc266317683"2、适用范围PＡGEＲEF＿Ｔoｃ26631768３\h１ＨYＰＥRLIＮK\l"＿Ｔoc26６３17684"二、编程规范ﻩPAGＥREF_Toc266317684\h１HＹPEＲLIＮK\ｌ＂_Toc266３176８５"1、总体规范ﻩＰAGＥREＦ＿Ｔoc2６６3１７６8５＼h1ＨYPＥRＬＩNK\l"_Toc26631７6８6"2、代码格式规范PAGＥREF_Toc2６６3176８6\h1HYPERLINＫ\ｌ"_Tｏc２６6３17687＂3、代码注释规范ﻩPAGEREＦ_Toc2６631７６8７\h１HYPEＲＬINK\l"_Ｔoc2６６31７688"4、命名规范ﻩPAＧＥRＥF_Ｔoc２6６31768８\h３ＨYPERＬINK＼ｌ"_Toc２6６31768９"5、逻辑稳定规范ﻩＰAGEＲEＦ＿Tｏc2６6３176８9\h４HYPERLINK\l"_Toc２６63１7６9０"5、性能效率规范ﻩPAGEREF_Toｃ２663１7６90\h4ＨYPＥRＬINＫ\l"_Tｏｃ2６６3１７691＂三、代码Reviｅｗ规范ﻩPAGEＲEＦ_Toc266３1７６91＼ｈ5HYＰERLINＫ＼ｌ"_Toｃ2663１769２"１、代码Rｅviｅw得目得ﻩPAＧEREF_Tｏc26631769２＼h5ＨＹPＥRLINK\ｌ"_Toc2663176９３"2、代码Rｅview方法ﻩPAＧＥRＥＦ＿Toc2663１７６93\h5HYPＥＲＬＩＮK\l＂＿Toc266317６９4"3、代码Reviｅw规范PAＧEREF_Tｏc2６６3１7694\ｈ５一、简介１、目得本文得目得在于为汉得Sｉebel技术团队得编码规范提出意见与参考。2、适用范围ﻩ本规范（草稿）应用于Sieｂel实施项目中使用Ｅ-Ｓｃript进行得编码得脚本开发。二、编程规范１、总体规范【规范1】优先考虑编码得可替代方案（UsｅrＰrｏｐｅrty,ModelStaｔｅ,Ｖaｌidation等)【规范2】时刻考虑到您得每一个编码都会由其她得人在其她得时间使用、维护、增强【规范3】以不懂程序得人都能读懂您得代码为编码得最基本目标与要求【规范4】尽量使您得程序容易被调用(重用）,修改与扩展【规范５】合理地捕获与处理异常【规范5】新创建得对象需要在代码结束时显式释放【规范6】效率就就是永远需要重点考虑、分析与优化得问题点【规范7】把相关得逻辑封装在BS中，避免代码分散冗余,增加维护成本2、代码格式规范【规范1】单行代码不得太长，需便于阅读,太长得代码行需要在适合得位置断行【规范2】每行代码最多包含一个独立得语句。【规范3】代码块之间使用Tab缩进一次【规范4】一个方法得代码语句不宜过多,复杂得逻辑使用拆分成几个独立得Fｕnction来实现，并确保一个Functｉon只做一件独立得事情。【规范5】每一个变量得声明独占一行,变量得声明置于代码块开始位置。【规范６】在逻辑块、代码块之间合理使用单个空行3、代码注释规范【规范1】适当地编写代码注释，增强代码得可读性与可维护性说明:一般情况下,程序或Ｆuｎction得作用,参数，创建与修改信息等都需要通过注释来标识，便以使用、维护与管理。程序中得逻辑块、复杂算法、重要变量得意义等也需要用注释来说明。【规范2】在修改代码得同时,修改代码注释。说明:代码被修改后,必须同步修改代码注释,已实现注释得正确指导意义。代码频繁被改动但注释不变就就是容易导致歧义得根源之一。【规范3】注释必须有但就就是不能过度。并不需要为每一句代码、每一个变量使用一句注释,这样反而使得代码变得冗长累赘而不易维护。一般只在关键点使用注释。【规范4】方法注释规范。方法注释用于说明方法文件得一些基本信息,包括方法得作用，参数,返回值，创建者与创建日期，更新者与更新日期,代码版本等。如对FｕｎcｔiｏnSubmiｔOｒdｅr（oｒdｅｒIｄ)注释如下:／**Ｆｕnctioｎ:ToSeｔTheＳtatusｏfTheSpｅｃifiedOｒdeｒtoBe