ERP程序撰写规范.ppt

ERP 2009 01 21 将开发人员的编程风格在制度上统一 有助于团队的协同工作 避免因为编码风格不同产生的问题 前言 摆放目录 sysId config compId sysId html jsp src work xml dr compId sysId com icsc sysid dao func ui tag dx Config目录下摆放 ini文件和 xml文件 其中xml文件的命名是系统别 Structs 例如 mpvStructs xml mpv是系统别 Jsp目录下存放jsp文件jsp文件的命名 系统别 jj 序号 每个jsp页面必须有一个pageId pageId对应jsp页面的名称 可大小写混用 例如xxjj001 jsp pageId为xxjj001注 如果为三位的系统别 jsp文件命名为系统别 j 序号 Jsp页面编码规范 1 Jsp在开始处加上注释 描述相关信息 2 Jsp页面开始首行 必须是这行代码 3 Jsp页面代码开始次行 必须是这行代码 4 所有的declare必须写在JSP页面最前面 其次为scriplet的语句 JavaScript语句放到页面最下方 对于include的jss文件如果写在jsp下方有问题那么请在按照程序需要方式摆放 5 每个标签必须突出彼此间的层次感 一律以换行空4格的方式 例如 6 Script的include方式为以下样式 7 Script区中方法的定义层次清晰 每层之间空四格 8 其它编码规范请配合加强版Struts架构中Jsptaglib要求的写法 9 jsp中变量定义统一定义在页面最上方jsp语句开始前 系统Java文件Src目录摆放结构 icsc 系统别 dao 该目录下摆放所有该系统的dao和vo VO ValueObject DAO DataAccessObject 命名方式为mejc01VO和mejc01DAO icsc 系统别 func 该目录下摆放所有该系统的业务逻辑 业务逻辑命名方式 pageId 将第二个j改为c Func 如某pageId为xxjj001 那么对应的逻辑为xxjc001Func java icsc 系统别 ui 该目录下摆放所有该系统对页面的控制逻辑 Ui的命名与业务逻辑命名相对应 如果Func为xxjc001Func java 则ui一般为xxjc001UI java icsc 系统别 tag 该目录下摆放所有该系统对页面的用户自定义tag取值的逻辑 对应的class是com icsc dpms du tag dujcSelectcompId javacom icsc dpms du tag dujcRemoteFirDeptFinder java xml下存放Pdf报表文件的xml档Work下存放Excel报表文件 命名原则packages Package命名规则以系统为单位 另因DPMS系统为共享模块所以将统一命名 至于应用系统里同一业务但因个别公司商业处理逻辑不同需由共同程序分离时 其程序命名规则为在原程序后多加一位 而Package命名则相同 Package命名规则如下 com icsc XX 系统代号例子 com icsc aacom icsc dpms ducom icsc mp mpv ClassesAndInterfaces 程序 亦即Class 命名标准 8码 全小写 XXXXXXXX流水序号程序类别系统细项功能系统代号 程序类别 A APPLETB BEANC CLASSE EJBH HTMLI InterfaceJ JSPS SERVLETT SCRIPTX ExceptiZ CSS例如 aajj01 jsp aaje01 java dejtmf jss dswhelp html dzwcss gui Method 必须以动词为起头 由2 4字所组成 其动词第一个英文字母需为小写 下一个字 其第一个英文字母需为大写 字与字之间不以特殊符号分隔例如 run runFast getBackground 方法参数的命名方式请按照一定的逻辑顺序 比如按照key优先顺序摆放 Variables 变量命名需简短但具有意义 由1 3字所组成 其第一个字的第一个英文字母需为小写 且不得为特殊符号 接续的字 其第一个英文字母需为大写 字与字之间不以特殊符号分隔 最好避免以单一字母命名 除非该变量为暂存用途 通常这些变量命名规则为i j k m n为integer c d e为char DAO变量命名方式 表名 DAO VO变量命名方式 表名 VO 如表名为db tbme01 那么对应DAO变量名称命名为me01DAO VO变量名称命名为me01VO 多笔资料的变量定义为me01List Constants 常量命名需简短但具有意义 由1 3字所组成 所有字母皆为大写 字与字之间以underline 连接例如 staticfinalintMIN WIDTH 4 staticfinalintMAX WIDTH 99 Databases 原则上一个公司一个Database 全部以大写字母 命名规则如下 IDBXXXXX公司简称DB 代表Database中冠代号例如 idbbx Tables 全部以大写字母 命名规则如下 TBXXXX流水序号系统代号TB 代表Table例如 tbdsmf Columns 字段命名需简短但具有意义 由1 3字所组成 其每个字皆为大写 且不得为特殊符号 字与字之间不以特殊符号分隔 例如 userName deptName StoreProcedure 全部以大写字母 命名规则如下 SPXXXX流水序号系统代号SP 代表Storeprocedure例如 SPAA01 程序代码要求 1 必须有注释2 每个方法的行数一般不得超过50行 请将方法中的语句尽可能的重构 实现逻辑的封装 降低耦合性 每行语句不得超过120个字符 如果有超过 请短行在标点符号后面 短行后的语句请比上一行空四格的