• java命名规范


    用来标识 类名变量名方法名类型名数组名文件名 的有效字符序列 称为 标识符 ,即标识符是一个名字

    java关于标识符的语法规则 : 

    1)  只能由字母、下划线、美元符号和数字组成,长度不受限制 

    2)  不能以数字开头

    3)  不能是关键字 

    4)  不能使 true 、false 和 null (尽管 true 、 false 和 null 不是 java 关键字)

    需要特别注意的是,标识符中的字母是区分大小写的,hello 和 Hello 是不同的标识符 。

    项目名  ——  全部小写,比如pgs等

    包    名  ——  全部小写,比如com.dgx.learn  

    类    名  ——  首字母大写,帕斯卡命名法(又叫大驼峰式命名法),每个单词的首字母都要大写

    方法名、变量名 —— 首字母小写,驼峰式命名法(又叫小驼峰式命名法),即第一个单词首字母小写,后面其他单词首字母大写 

    常量名  ——  全部大写,多个单词则以_分开,比如BOOLEAN_FLAG

    文件命名 

    1、属性文件.properties定义变量命名

      object.a_b_c格式,全部小写,其中object是宿主,a_b_c多个单词下划线分开。

      例:hibernate.cache.use_second_level_cache,hibernate.cache.provider_class,hibernate.cache.provider_configuration_file_resource_path

    2、xml 文件命名

      全部小写,-符号是其xml的用途说明,类似applicationContext习惯命名。

      比如springmvc-servlet.xml、workdesk-manager.xml、workdesk-servlet.xml、applicationContext-basic.xml等

      xml里的内容多个字符间以-隔开,比如param-name,filter-mapping等

    3、普通文件命名(jsp,js,img等)

      和java普通变量规范相同

    4、属性文件properties

      以下划线隔开:errors_zh_CN.properties,hibernate_test.properties

    数据库相关命名规范

    数据库名   ——   

      采用26个英文字母(区分大小写)和0-9的自然数(经常不需要)加上下划线'_'组成,命名简洁明确,多个单词用下划线'_'分隔

    数据表名   ——   

      (1)采用26个英文字母(区分大小写)和0-9的自然数(经常不需要)加上下划线'_'组成,命名简洁明确,多个单词用下划线'_'分隔

      (2)全部小写命名,禁止出现大写

      (3)禁止使用数据库关键字,如:name,time ,datetime,password等

      (4)表名称不应该取得太长(一般不超过三个英文单词),可适当缩写

        例如:明细表的名称为:主表的名称+字符dtl(detail缩写)

        采购定单的名称为:po_order,则采购定单的明细表为:po_orderdtl 

      (5)用单数形式表示名称,例如,使用 employee,而不是 employees

      (6)填写描述信息(使用SQL语句建表时)

    字段名   ——    

      (1)采用26个英文字母(区分大小写)和0-9的自然数(经常不需要)加上下划线'_'组成,命名简洁明确,多个单词用下划线'_'分隔

      (2)全部小写命名,禁止出现大写

      (3)字段填写描述信息

      (4)禁止使用数据库关键字,如:name,time ,datetime password 等

      (5)采用字段的名称必须是易于理解,一般不超过三个英文单词

      (6)在命名表的列时,不要重复表的名称

        例如,在名employe的表中避免使用名为employee_lastname的字段

      (7)不要在列的名称中包含数据类型

      (8)字段命名使用完整名称,避免缩写

     

     

    注释规范

    1、   类注释

    在每个类前面加上类注释,注释模板如下:

    // Copyright (c) 2018-2019
    // ============================================================================
    // CURRENT VERSION DGX.1.0.0
    // ============================================================================
    // CHANGE LOG
    // DGX.1.0.0 : 2019-XX-XX, 创建者姓名, creation
    // ============================================================================

    /**

    * Copyright (C), 2018-2019

    * FileName: Test.java

    * 类的详细说明

    * @author 类创建者姓名
        * @Date    创建日期

    * @version 1.00

    */

    2、   属性注释

    在每个属性前面加上属性注释,注释模板如下:

    /** 提示信息 */

    private String strMsg = null;

    3、   方法注释

    在每个方法前面加上方法注释,注释模板如下:

    /**

    * 类方法的详细使用说明

    * @param 参数1 参数1的使用说明

    * @return 返回结果的说明

    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    4、   构造方法注释

    在每个构造方法前面加上注释,注释模板如下:

    /**

    * 构造方法的详细使用说明

    * @param 参数1 参数1的使用说明

    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    5、   方法内部注释

    在方法内部使用单行或者多行注释,该注释根据实际情况添加。

    如://背景颜色

           Color bgColor = Color.RED

     共同学习,共同进步,若有补充,欢迎指出,谢谢!

  • 相关阅读:
    Hadoop 文件系统命令行基础
    Mac bash 远程连接阿里云服务器
    Master in Vocab -- Day Six
    Master in Vocab -- Day Five
    Master in Vocab -- Day Four
    Master in Vocab -- Day Three
    mybatis学习一
    mysql事务,视图,权限管理,索引,存储引擎(胖胖老师)
    SpringAOP
    Spring事务
  • 原文地址:https://www.cnblogs.com/dengguangxue/p/10754646.html
Copyright © 2020-2023  润新知