代码规范脚本

代码规范脚本篇一：代码规范代码规范 1. 定义类、变量、方法、函数时，命名要准确，使用含有实际意义的英文名称，以便理解。 不得乱用简称，不得使用数字命名区分变量。 2. 代码过程中时刻注意边界值的检查。 3. 对无需公开的类，使用 internal 修饰符，慎用public 修饰符。 4. 命名空间定义遵循以下规范： ? 项目名+.Biz(接口、常量、Enum、Common 方法) ? 项目名+.BizImpl(Biz 的实现类) ? 项目名+.BizDal(数据库类) ? 项目名+.Web(前台页面) 5. 善用代码注释，关键逻辑、复杂算法必须有注释说明，对函数、参数及返回值进行说明。 多态方法的注释按照要求书写，脚本代码必要时必须给予注释。 6. 对于构造函数，必须重新给予定义，不能使用缺省定义。 7. 同类代码使用#region 标记进行区分。 8. 不得在代码中直接使用常数，凡是常量的调用，必须以变量赋值的方式进行。 9. 注重代码的重构，凡是重复的逻辑，应当将该逻辑提取形成方法，以调用的方式运用该 逻辑。尽量精简函数的代码量。 10. 多余、废弃的代码要从代码中移除。 11. 尽量做到一个文件中只包含一个类。 篇二：程序代码简要规范程序代码简要规范 第一章 程序代码规范 程序代码规范旨在为.Net、Java、Flex 等常见程序开发技术的代码提供通用的规范，约束程序代码中关键和通用的部分，以方便代码的复用和后期的维护。 包命名（命名空间） 要求：格式为：应用名称.?；对于第三方的代码，如果有改动，也需采用此命名。 例如：防伪项目 Java 包： ?； 防伪项目 Net 命名空间： ?； 防伪项目 Flex 包： ?。 类、方法和变量命名 要求：使用英文单词组合进行命名，并且相邻的单词首字母大写（即驼峰命名规则） ；全局变量或常量所有字母大写命名。 例如：类 UserService ，方法 getUserInfo() ，全局变量或常量 COUNT。 注意：1，不能使用中文汉字命名； 2，不能使用汉语拼音命名； 3，要使用有实际意义的英文单词。 页面(Jsp|)、样式和脚本命名 要求：使用英文单词组合进行命名，并且全部小写。 样式和脚本一般要求保存在单独的目录中，并且目录和文件名称全为小写英文。 例如：user userjs 代码冗余 必须去掉所有未使用的注释掉的代码，以及页面中未使用的 Javascript 代码、样式代码、html 元素。 代码复用原则在代码中避免重复的代码，需将重复的代码重构成可复用的函数。 当一个复杂函数中代码量超过了 100 行时，需拆分成多个可复用的函数，每个函数的代码量控制在 100 行以内。当一个复杂类中代码量超过了 XX 行时，需拆分成多个类，每个类的代码量控制在 XX 行以内。 分层与命名(参考) 本部分可参考使用，代码中有此层需依此命名，无此层可自行命名，但包命名（命名空间）不可变化；对于接口类和实现类命名格式，.net 和 flex 可依据通用命名习惯，不依此要求。 控制层命名： 格式： .应用名称.action.模块名 例如： 业务层命名： 接口格式： .应用名称.service.模块名 例如： 实现类格式： .应用名称.模块名 例如： 持久层命名： 接口格式： .应用名称.dao.模块名 例如： 实现类格式： .应用名称.模块名 例如： 持久化对象命名： 格式： .应用名称.model.实体对象名 例如： 代理层命名：格式： .应用名称.delegate.模块名 例如： 一般情况下不要求使用代理层，但是如果使用第三方的组件是，不能在代码中直接调用第三方的组件包，必须使用专门的代理类进行包装。 注释： 1. 所有类、接口、非私有方法必须详细注释； 2. 关键算法中使用的变量必须详细注释，最好包含调用的 demo； 3. 代码更新时，注释必须同时更新，更新内容包括修改人员、修改时间、修改内容。当方法（或类）修改的量达到 40时，必需重构； 4. 注释的量要求达到 20%以上； 5. 尽量使用中文注释，除非此处用英文可以精准的表达意思。 异常： 1. 2. 3. 4. 所有异常不能抛弃； 所有异常需记录日志，不能在控制台输出； 充分利用 finally 释放占用资源； 所有自定异常需继承自 数据有效性： 验证网页数据有效性，需先在前台脚本中验证，然后在服务器上进行后台验证； 测试： 1. 单元测试要求达到语句覆盖。 2. 单元测试要跟踪每一条语句，并观察数据流与变量的变化。 3. 功能类都应该使用 JUnit 进行单元测试。 第二章 JavaScript 脚本和样式规范 总则 文件命名 JavaScript 文件命名规则为: 英文小写目录+英文小写文件名称.js 样式文件命名规则为: 英文小写目录英文小写文件名称.css 例如：js/ , css/ 样式脚本页面分离原则 JavaScript 代码若不是该 HTML 文件所专用的，避免在 HTML 文件中直接编写 JavaScript 代码。因为这样会大大增加 HTML 文件的大小，无益于代码的压缩和缓存的使用。同理样式也需和 html 文件分离。 跨浏览器兼容原则 必须使用跨浏览器兼容的脚本和样式，必须兼容IE6、IE7、IE8、IE9、Firefox3。 Javascript 脚本规范 面向对象编程 需使用面向对象的方式编写 js 脚本。 减少全局变量的使用。将全局变量加上应用名称作为命名空间。如下所示： mapfy = globalVar?:?testglobal?, globalVarTwo?:?testglobal? 使用上面的全局变量则如下： 变量和方法命名 变量和方法使用英文单词组合进行命名，并且相邻的单词首字母大写（即驼峰命名规 则） 。注意： 1. 2. 3. 4. 5. 不能使用中文汉字命名； 不能使用汉语拼音命名；要使用有实际意义的英文单词； 不要在命名中使用 “$”（美元符号）或者 “”（反斜杠） ； 不要把 “_”（下划线）作为变量名的第一个字符。 样式规范 样式精简原则 编写 css 样式文件时尽量做到精简，一个属性能解决的就不要使用多个属性。 图标合并原则 编写 css 样式时，需将背景小图标放在同一张图片中通过位置偏移来控制图片的显示。 css 文件名命名规范 模块： 基本共用： 布局、版面： 主题： 专栏： 文字： 表单： 补丁： 打印： 页面结构元素 div 命名规范 头：header 内容：content/container 尾：footer 导航：nav 侧栏：sidebar 栏目：column 页面外围控制整体布局宽度：wrapper 篇三：自动化脚本编写规范自动化脚本编写指南 郑州大方软件股份有限公司 文件变更记录*变更类型：A - 增加 M - 修订 D - 删除 目录 1 2 3 前言： .4 名词注释 .4 测试脚本命名规范 .4 4 基本信息 .4 文件夹命名 .4 脚本命名 .5 变量命名 .5 常量命名 .5 参数命名 .6 函数/方法/接口命名 .6 代码注释规范 .6 换行. 7 分活动测试的优点 .7 业务流程测试的简易流程 .7 业务流程测试 .7 整个流程的开发过程 .8 1 前言： ? ? ? 本规范的目的是让保证测试部成员编码的统一。 本规范的核心规则就是自动化脚本的命名规则。 此规范必要时可以打破。 2 名词注释 ? 业务流程测试用例：关于产品业务、重要流程的测试用例。 3 测试脚本命名规范 基本信息 在每个脚本模块的最上面，必须写上脚本运行的软件、项目名称、脚本编写人（使用英文名或中文拼音缩写） 、脚本创建时间、脚本修改时间、修改说明、输入参数、输出参数、脚本描述等。 文件夹命名 系统中整个目录结构与 CLEARQUEST 中测试用例目录结构保存一致，第一级为系统名称，第二级为模块名称、第三级为测试用例集名称。分为三大块：testaction、testcase、testobject。 Testobject：主要存放编写测试用例对应的所有页面对象。存放测试对象脚本大小以测试用例集为最小单位。 Testaction：要存放该用例集对应的系统操作组合。脚本大小以测试用例集为最小单位。 Testcase：主要存放所有的业务用例脚本，测试用例与测试用例脚本为一对多的关系。由于测试用例中对应很多条数据，一个测试用例脚本不能涵盖所有的测试用例内容，我们可以通过多个脚本实现。脚本名称后加后缀，为脚本序号，例如：1,2,3. 以下为现有的目录结构： ? ? ? 目录和文件一般采用小写的格式，尽量使用两个以内的单词表达。 不建议使用下划线间隔的方式。但如果目录或者文件名过长，无法使用少量单词表达时，应当使用下划线。 不建议使用大写字母，但如果要表达的名称是大家约定俗称的，应尊重旧有的习惯。 脚本命名 脚本命名与页面名称保持一致，可参考开发的命名。 变量命名 变量命名应该简单，应尽量使用缩写。如果是一般的值类型（如 integer string） ，则直接使用变量用途命名。尽量使用全名，例如，String name；如果是一般的临时性变量定义，应该尽可能地简单，例如，Int i；如果名称由多个单词组成，