Java 基础（4）——常量 & 注释

hello 呀，今天的内容超简单（￣︶￣）↗
并且，还有暗藏福利哟~~

常量

常量 就是常常不变的量，第一次定义之后，就不会发生改变了。可能这就是 “常量” 的来源吧哈哈哈（玩笑）。

一般来说，常量的定义用

public static final 类型 变量名 = 值

这样子。

public class Test {
  public static final double PI = 3.14;
  public static void main(String[] args) {
    int r = 5;  // 定义一个半径r
    double area = PI * r * r;  // 求出平方
    System.out.println("面积是：" + area);
  }
}

结果：

 

那么…… 什么时候用呢？
如果你需要重复多次使用某一个数值或者字符串的时候，如果使用变量的话，可能在使用过程中不小心改变。那么定义一个常量的话，就可以解决这个问题，因为什么呢？

因为常量不定义之后就不会改变了~

注释

一般来说，大家都上过学啊，都读过语文。在学文言文的时候下面的注释是不是很有必要呢？但是你在读文言文的时候也不会把注释也读进去吧~

程序上的注释也都是如此。Java 中的注释第一不会参与程序的执行，第二可以方便到大家阅读自己的代码（不写注释的话万一过了一段时间自己都忘了呢…… 啷个办）。

Java 中的注释有三种：

1. 单行注释

//单行注释 注释一行内容
int ahan = 0;

1. 多行注释

/*
多行注释
注释多行内容
*/
int ahan = 0;

1. doc 注释

/**
 * doc注释 会生成一个类似于Java的帮助文档
 * @date 2019年04月10日
 * @author ahanwhite
 */
int ahan = 0;

命名规范（2）

之前有过命名规范（1），因为规范太多啦，所以会将完整的代码规范文件给到百度云，微信公众号后台回复Java规范就可以获取链接啦~

1. 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。for example: MAX_STOCK_COUNT

常量定义（1）

这个是规范中编程规约的第二个部分，主要讲到常量的一些内容。

1. 不允许任何魔法值（即未定义的常量）直接出现在代码中。
   ps. 莫名其妙出现的原来没有的东西，可称之为魔法 (▽)

2. Long 或者 long 初始复制时，使用大写的 L，不能是小写的 l，小写容易与数字 1 混淆，造成误解。
   ps. 不仅 l 和 1 容易误解还有 I 这个，还有 o0O（你猜哪个是零呢）、还有容易混淆的;；这两个~ attention 哦

3. 【推荐】不要用一个常量类维护所有的常量，尽量按照常量的功能进行归类，分开来维护哦~
   ps. 一个文件里有太多东西不好找啊

4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
   1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。
   2） 应用内共享常量：放置在一方库中，通常是 modules 中的 constant 目录下。
   反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示 “是” 的变量：
   类 A 中：public static final String YES = "yes";
   类 B 中：public static final String YES = "y";
   A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致线上问题。
   3） 子工程内部共享常量：即在当前子工程的 constant 目录下。
   4） 包内共享常量：即在当前包下单独的 constant 目录下。
   5） 类内共享常量：直接在类内部 private static final 定义。

5. 【推荐】如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。

声明：编码规范来自于阿里巴巴 Java 开发手册。有兴趣的同学可以去看一下哦~

本章的编码规范只讲到本文用到的那一部分，且后文不再讲述~
以上，阿里嘎多，20190405 from ahanwhite。