zoukankan      html  css  js  c++  java
  • Java~命名规范

    下面总结以点java命名规范

    虽然感觉这些规范比起C#来说有点怪,但还是应该尊重它的命名!

    命名规范

    1. 项目名全部小写
    2. 包名全部小写
    3. 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。
    4. 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。
    5. 常量名全部大写
    6. 所有命名规则必须遵循以下规则:
      *. 名称只能由字母、数字、下划线、$符号组成
      *. 不能以数字开头
      *. 名称不能使用JAVA中的关键字。
      *. 坚决不允许出现中文及拼音命名。

    注释规范

    1 类注释

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

    /**
    * 类的详细说明
    *
    * @author 类创建者姓名
    * @Date    创建日期
    *   @version 1.00
    */
    
    2 属性注释

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

    /** 提示信息 */
    private String strMsg = null;
    
    3 方法注释

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

    /**
    * 类方法的详细使用说明
    *
    * @param 参数1 参数1的使用说明
    * @return 返回结果的说明
    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
    */
    
    4 构造方法注释

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

    /**
    * 构造方法的详细使用说明
    *
    * @param 参数1 参数1的使用说明
    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
    */
    
    5 方法内部注释

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

    //背景颜色
    int init =1;
    

    待续...

  • 相关阅读:
    自定义Toast
    kafka概念扫盲
    ZooKeeper面试题
    写给程序员儿子的一封信
    hashCode() 和 equals()的问题解答及重写示范
    git下载安装、配置及idea初始化
    配置 git公钥报错:unknown key type -rsa
    Java中的各种锁
    Kafka 基本原理
    MySQL 索引总结
  • 原文地址:https://www.cnblogs.com/lori/p/8335387.html
Copyright © 2011-2022 走看看