zoukankan      html  css  js  c++  java
  • Java ——注释 命名

    注释
    1、类
    在每个类前面必须加上类注释,注释模板如下:
    /**
    * Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
    * 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
     
     

    Java命名

    包名: 由全部小写-------------------com.runoob
     
    类和接口:大写开头其他小写-------Person,RuntimeException
     
    类变量: 小写开头后面大写-----------currentImage
     
    类方法的: 小写开头后面大写----------getBalance()
     
    staticfinal变量: 大写-----------------PASSWORD
     
    参数: 参数的名字和变量的命名规范一致
     
    数组: byte[] buffer
  • 相关阅读:
    secureCRT使用pem私钥
    常用的GoLang包工具
    解决vs code 调试golang时字符串显示不全的问题
    git 常用操作
    go sqlx db.Query需手动释放
    go dlv 调试
    Ambari中superset-hive认证
    HDP3.x hive load data local inpath 设置
    dolphinscheduler-调度
    sourceTree 提交错误
  • 原文地址:https://www.cnblogs.com/expedition/p/10832306.html
Copyright © 2011-2022 走看看