我的工程实践做的是JAVA前后端编程,所以我挑选了一个Github上的JAVA小游戏来分析代码。
因为我刚开始学习java,所以就选了一个简单的小游戏。
一、命名
类名采用大驼峰的命名形式,所谓大驼峰就是首字母大写,例如FlyingObject.class
抽象类命名使用 Abstract 或 Base 开头;异常类使用 Exception 结尾;测试类命名以测试的类名开始,以 Test 结尾。
很多同学在入门编程时,有一些很不好的习惯,最突出的就是命名。命名要遵循简洁明了的原则,使人一看就能明白这个变量或者函数是什么意思。在经历多次练习之后 ,相信一定会有所改进的。
二、代码有很多注释,可以清晰展现思路
1.块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:
# Description : Module config. # # Input : None # # Output : None
2. 行注释,在一句代码后加注释。比如:x = x + 1 # Increment x 但是这种方式尽量少使用。
3. 避免无谓的注释。
注释:程序中必须有清晰的注释;每个函数(除main函数外)都要注释功能说明;代码中要有适当的注释说明代码的作用。
缩进:用空格和Tab均可,但是两者不要混用
标识符命名:标识符由字母(A-Z,a-z)、数字(0-9)、下划线“_”组成,并且首字符不能是数字,但可以是字母或者下划线,例如正确的标识符:abc,a1,prog_to;
不能把C语言关键字作为用户标识符,例如if ,for, while等
其他:左大括号“{”后和右大括号前“}”均不可出现代码;每行只能写一条代码;常数应定义为宏、枚举或常量;