Java代码强制规范 - kyohwang/games GitHub Wiki

注释(内容变化,注释必须同步更新)

注释条件:

1、基本注释(必须加)
(a) 类(接口)的注释 : 作者、作用、Service加上功能名字
(b) 方法的注释
(c) 全局变量的注释
(d) 字段/属性的注释

2、特殊必加注释(必须加)
(a) 典型算法必须有注释。
(b) 在代码不明晰处必须有注释。
(c) 在循环和逻辑分支组成的代码中加注释。
(d) 为他人提供的接口必须加详细注释。

文件编码

编码一律使用UTF8,包括代码、配置文件等

import不要使用通配符

即,不要出现类似这样的import语句:import java.util.*;

使用大括号(即使是可选的)

大括号与if, else, for, do, while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。

⚠️ **GitHub.com Fallback** ⚠️