Browse Source

Updated files

master
adiao 3 years ago
parent
commit
9827886a74
  1. 3
      项目命名/项目命名格式.md

3
项目命名/项目命名格式.md

@ -379,7 +379,7 @@ e. 构造方法注释 @@ -379,7 +379,7 @@ e. 构造方法注释
1. 枚举类的各个属性值都要使用注解,枚举可以理解为是常量,通常不会发生改变,通常会被在多个地方引用,对枚举的修改和添加属性通常会带来很大的影响。
2. 保持排版整洁,不要使用行尾注释;双斜杠和星号之后要用 1 个空格分隔。
```
id = 1;// 反例:不要使用行尾注释
//反例:换行符与注释之间没有缩进
int age = 18;
@ -390,6 +390,7 @@ String name; @@ -390,6 +390,7 @@ String name;
*
* 2. 对于不同的逻辑说明,可以用空行分隔
*/
```
总结
无论是命名和注解,他们的目的都是为了让代码和工程师进行对话,增强代码的可读性,可维护性。优秀的代码往往能够见名知意,注解往往是对命名的补充和完善。命名太南了!
Loading…
Cancel
Save