欢迎来到天天文库
浏览记录
ID:58219150
大小:24.99 KB
页数:8页
时间:2020-04-28
《代码走查规范.docx》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、维远泰克代码走查规范文件编号:起草部门:测试组审核人:签发人:批准日期:版本标识:目录1引言41.1目的41.2说明42代码走查42.1检查点42.2走查流程42.2.1走查流程图52.2.2流程概述52.2.3具体流程52.2.3.1创建任务92.2.3.1个人走查92.2.3.1团队评审92.2.3.1修复问题9文件修改控制序号版本时间修订人说明1234567891011121314151617181920212223241引言1.1目的检查开发人员是否遵守以下规范中的内容:《Java开发标准规范(Ver1.3)》《CSS开发标准规范(Ver1.3)》《JavaScr
2、ipt开发标准规范(Ver1.3)司》《数据库设计标准规范(Ver1.3)》《第三版开发平台使用规范(Ver1.1)》统计错误,为月底绩效考核做参考1.2说明代码走查两周进行一次,根据这些规范中的内容进行检查打分。2代码走查2.1检查点a)注释检查(javajscss)是否写注释注释和代码内容是否匹配注释是否规范。被注释的代码如果已经没有价值,最好去掉Java注释检查:版权信息注释、类注释、成员注释、方法注释、内部类注释、代码修改注释等其他注释Js注释检查:版权信息注释、组件注释、变量注释、函数注释等Css注释检查:版权信息注释、选择符注释b)源文件的检查(javajsc
3、ss)检查源文件命名规范源文件版权信息和版权声明c)java空格、空行、缩进的检查不要有多余的不必要的空白缩进4个空格d)Java引用的检查尽可能不要使用import*不要有无效的引入尽量减少引入同名的类(如java.sql.Date,java.util.Date)a)java命名规范检查包接口类方法变量常量等是否符合规范b)java语句编写是否规范(1)简单语句赋值和表达式本地变量声明数组的声明Return语句(2)复合语句括号的格式If语句的格式for语句while语句SWITCH语句检查c)检查是否有重复的代码,是否可以用统一的方法实现d)是否有更好的实现方式e)检
4、查代码逻辑是否正确f)css样式类命名是否规范的检查g)检查引入样式文件是否正确,杜绝使用@importh)Css空白检查(空行、空格、缩进)不要有不必要的空行缩进2个空格i)检查css中类选择符“.”和ID选择符“#”使用使用是否规范j)Js命名规范的检查(组件、变量、函数的命名)k)Js空白检查(空行、空白、缩进)不要有不必要的空行缩进2个空格l)Js语句检查m)Htmljsp检查注意缩进两个空格,例如
5、不必要的空白不要有多余的标签。例如某个地方又多余的1.1走查流程MyEclipse中需要安装Findbus、checkStyle、Jupiter插件,辅助走查工作。2.2.1走查流程图确定走查代码、走查人,bug类型等建立走查任务个人走查结束走查任务发现bug确定bug类型及严重度提交review数据团队更新review数据,审核bug删除bug确认为bug分派修改人及解决方式更新review数据,修复bug,修复完提交review数据走查人更新review数据,复测已修改的bug重新打开bug,提交review数据确认已修复关闭bug,提交review数据结束
6、走查任务2.2.2流程概述1.建立review任务:代码修改者或TL建立review任务,指定需评审的代码文件、参与评审的人员、定义问题类型及严重级别等。2.个人评审阶段:开始个人独自评审,将可能出现的问题加入问题列表。3.团队评审阶段:团队成员坐在一起,讨论个人评审阶段的问题,确定是否需要修复并分配解决人员。4.问题修复阶段:每个人修复分配给自己的问题,修复后修改问题状态。2.2.3具体流程2.2.3.1建立review任务(1)选择一个要走查的项目,右键点击项目名称,选择“Properties”显示项目属性窗口。(2)选择“Review”将显示Jupiter属性(3)
7、点击“New”按钮打开新建ReviewID对话框,输入ReviewID(需符合文件命名规则)和Description(4)选择需要Review的文件,可一次选择多个(5)设置参加Review的人员(6)选择评审负责人(7)设置问题类型及严重级别和filter,根据实际情况修改或用默认值,finish后会在工程根目录生成.jupiter文件,提交该文件到SVN或CVS2.2.3.2个人评审借助走查工具Findbus、checkStyle等寻找bug并使用Jupiter记录bug。(1)从SVN或CVS上更新药走查的源代码和.ju
此文档下载收益归作者所有