学习嵩山版《Java 开发手册》:编程规约 - 命名风格(P13 ~ P14)
概述
-
《Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结,他旨在提升开发效率和代码质量
-
《Java 开发手册》是一本极具价值的 Java 开发规范指南,对于提升开发者的综合素质和代码质量具有重要意义
-
学习《Java 开发手册》是一个提升 Java 编程技能、了解行业最佳实践和规范的好方法
编程规约 - 命名风格 P13
1、基本介绍
- 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达。
-
正例:对某个对象引用的 volatile 字段进行原子更新的类名为 AtomicReferenceFieldUpdater。
-
反例:常见的方法内变量为
int a;
的定义方式。
2、学习补充
- 循环中变量为
int i;
的定义方式是简洁且可接受的
for (int i = 0; i < 100; i++) {
}
编程规约 - 命名风格 P14
- 【推荐】在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。
// 正例
startTime
workQueue
nameList
TERMINATED_THREAD_COUNT
// 反例
startedAt
QueueOfWork
listName
COUNT_TERMINATED_THREAD