编程规约与规范.pptVIP

任务四 编程规约与规范 系统详细设计命名规约 4.1 Java编程规约 4.2 HTML编程规约 4.3 JavaScript编程规约 4.4 4.1 系统详细设计命名规约 1．页面ID 2．数据库表名 3．类（class）名 控制层（C层）类名的记述格式：　 页面ID + 「Action」 动作层（C1层）类名的记述格式： 页面ID + 功能描述 + 「Action」 业务层（F层）类名的记述格式： 页面ID + 功能描述 + 「Work」 4.2 Java编程规约 4.2.1 命名规约 1．源文件的命名 2．类（class）、接口（interface）及包（package）的命名 3．成员方法的命名 4．成员变量的命名 5．常量的命名 6．局部变量和参数的命名 4.2.2 Java程序书写规范 1．Java程序代码的记述顺序 2．折行及缩进式书写格式 3．代码记述规则 4．语句记述规则 4.2.3 类的定义 1．类的修饰词 修 饰 词 类/接口说明 public 其他包可以访问 未指定 包内访问 abstract 抽象类定义 final 不能被子类继承 类的修饰词 2．类的作用域（有效范围） 作用域 修饰词 类/接口 instance成员变量/instance成员方法 Public 其他包可以访问 允许包内访问时，其他包也能访问 protected 包内和子包可以访问 未指定 包内访问 private 类内访问 表4-2 类的作用域 4.2.4 变量定义 1．成员变量 2．局部变量 3．变量作用域 变 量 作 用 域 成员变量 全体成员函数外部定义的变量 静态变量：全体类可以访问 实例变量：实例单位访问 局部变量 成员函数中定义的变量 成员函数内有效 表4-3 变量作用域 4.2.5 注释规范 1．注释 2．javadoc 3．注释标准 异常处理 本实训工程中只允许抛出3类异常： SystemException、BusinessException和Exception。通常情况下SystemException只在底层类中处理，原则上各业务模块开发中只使用BusinessException。 4.3 HTML编程规约 4.3.1 HTML代码记述规约 1．缩进书写 2．初始设定 3．其他注意事项 4.3.2 HTML命名规约 4.4 JavaScript编程规约 4.4.1 模块构成 1．HTML内JavaScript的记述规则 2．JavaScript的记述 3．JavaScript中变量/常量的记述规则 4．函数的记述规则 5．函数的返回值 6．注释 7．外部文件（.js）的记述规则 4.4.2 注释规约 1．头部注释 （1）文件注释 （2）函数注释 （3）修改代码的注释 2．变量注释 3．逻辑块注释 4.4.3 代码记述规约 1．编程注意事项 （1）函数定义 （2）逻辑记述的注意事项 2．变量定义 必须使用var定义变量。 （1）全局变量 3．Cookie控制 4.4.4 命名规约