• 项目开发规范


    代码规范

    驼峰命名法:

    类或者接口 单词首字母大写 UserAction  UserInterfaceDao

    应用系统中经常应用分层,Dao层(数据库访问)、Service层(业务处理)、Web层(页面控制action类),每一层的类的名称尽量带上该层后缀。

    1、Dao层

        a、接口类:采用JavaBean+Interface+Dao的形式来定义,即,实体对象+Interface+Dao。

        如:用户对象接口类: UserInterfaceDao,其中xxx为模块名称。

        b、实现类:采用JavaBean+Interface+Impl+Dao的形式来定义,

     即实体对象+Interface+Impl+Dao。 如:用户对象实现类:UserInterfaceImplDao

    2、Service层

        a、接口类:采用Xxx+Interface+Service的形式来定义,即,模块+Interface+Service。

         如:用户管理接口类:UserMsgInterfaceServiec

        b、实现类:采用Xxx+Interface+Impl+Service的形式来定义,

         即模块+Interface+Impl+Service。如:用户管理实现类:UserMsgInterfaceImplServiec

    3、Web层(action类)

        a、实现类:采用县 Xxx+Operator+Action的形式来定义,即,模块+操作+Action。

      如 用户模块User+删除操作Delete+Action = UserDeleteAction

    变量、方法 :第一个单词小写 userName saveUser()

    常量 :全部大写单词之间 _ 隔开  使用有意义的名称少用缩写 GOODS_PRICE

     

    注释:/** **/ //

    在代码中加入适量的注释  说明步骤和逻辑

    适当增加空行/分段 增强可读性

    格式化代码 一个类中的代码不要太多 一个方法中的代码不要太多

    一个类中的代码尽量转移

    代码相应的缩进

     

    代码

    保证有效(可以解决问题)

    清晰(有效的前提下代码几口与思路清晰)

    简洁  代码与逻辑尽量简单

    实体类主键类型使用Long 默认采用utf-8

     包名命名规范

     推荐使用公司或机构的顶级域名为包名的前缀,目的是保证各公司/机构内所使用的包名的唯一性。包名全部为小写字母,且具有实际的区分意义。

     开发前花时间去想好开发流程规范,尽量细化、明确需求,想好整体设计对开发效率和后期维护、扩展是很有利的

     

  • 相关阅读:
    单例模式的三种写法
    ASP.NET如何下载大文件
    字符串是引用类型
    SQL 事务隔离级别
    Sql Server 锁
    设非主键为聚集索引
    C#如何使用SqlCacheDependency
    简易系统后台架构
    matlab cross 3*1 向量叉乘
    Matlab求齐次方程的解
  • 原文地址:https://www.cnblogs.com/laotan/p/3687450.html
Copyright © 2020-2023  润新知