Java 基础 —— 编码规范

编码规范对于开发高质量的软件而言，有着非常现实的重要意义。

规范的编码能够

1. 减少一个软件的维护成本
2. 改善软件的可读性
3. 最大限度的提高团队开发的合作效率
4. 开发人员养成好的编码习惯，甚至锻炼出更加严谨的思维

注释

对代码进行解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写源码的作者给一个语句、程序段、函数等的解释或提示，以提高程序代码的可读性。

行注释 //
块注释 /* */
文档注释 /** */

/**
 * HelloWorld 程序是学习 Java 编程的入门程序。
 *
 * @author marvelousness
 * @mail 981247127@qq.com
 * @date: 2020-02-27 14:00:00
 */
public class HelloWorld {
	
	/**
	 * 主函数
	 * 1. 在执行程序时，由系统调用 main 函数
	 * 2. 程序执行总是从 main 函数开始，如果有有其他函数，则完成对其他函数的调用后再返回到主函数，最后由 main 函数结束整个程序。
	 * 3. main 函数是在程序启动中完成对具有静态存储期的非局部对象的初始化之后被调用的。
	 * 4. 它是程序在有宿主 (hosted)环境（亦即有操作系统）中所指定的入口点。
	 * 
	 * @author marvelousness
	 * @mail 981247127@qq.com
	 * @date: 2020-02-27 14:00:00
	 */
	public static void main(String[] args) {
		// 调用系统内置的打印函数向控制台输出 "Hello World!" 字符串		
		// System.out.println("Hello World!");
		
		/*
		
		如果字面量中包含中文字符，则编译的时候应该指定支持中文的字符集
		
		cls && javac -encoding UTF8 HelloWorld.java && java HelloWorld
		
		*/		
		System.out.println("您好，世界！");
	}

}

在工具 Eclipse 中，我们通常希望自动生成文档注释，比如在注释中加入作者，联系邮箱，格式化的时间文本。

/**
 * 
 * @author marvelousness
 * @mail 981247127@qq.com
 * @date: ${currentDate:date('yyyy-MM-dd HH:mm:ss')}
 */

标识符

指用来标识某个实体的一个符号，在不同的应用环境下有不同的含义。在计算机编程语言中，标识符是用户编程时使用的名字，用于给变量、常量、函数、语句块等命名，以建立起名称与使用之间的关系。标识符通常由字母和数字以及其它字符构成。

在当前的 HelloWorld 源程序中，有 HelloWorld, main, args 三个标识符，分别代表的是一个类，一个函数和一个形式参数。

一般来讲，对标识符的命名规则我们会有多种选择，主要的有如下三种：

1. 驼峰（Camel）命名法：除首字母外，每个单词首字母大写。例如：helloWorld
2. 帕斯卡（Pascal）命名法：所有的单词首字母大写。例如：HelloWorld
3. 所有单词全部采用小写，每个单词使用下划线隔开。例如：hello_world

我们在为类命名的时候，一般采用帕斯卡命名法，如果这个类使用 public 修饰符修饰，则该类必须声明在与类名同名的源程序文件中，例如本例中的 HelloWorld 类，使用的是 public 修饰，故而，我们必须将该源程序的文件名命名为 HelloWorld.java

我们在为函数命名的时候，一般采用驼峰命名法，例如 main 函数, println 函数, readLine 函数等。

我们在为数据库中的数据表或者表字段命名的时候，一般采用第三种命名规则，例如 information_schema 库, help_topic 表, help_topic_id 字段

---

阿里巴巴Java开发手册

关于开发规范，这里推荐 阿里巴巴 Java 开发手册 - 华山版 - v1.5.0 ，它涵盖了编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约等方面，值得大家学习并遵守，让我们一起码出高效、码出质量。

该链接地址来自 阿里技术 微信公众号，如果下载链接失效，请移步 阿里技术 微信公众号回复发送 手册 即可免费获取。

更多内容可移步阿里巴巴官方博客 —— 《Java 开发手册》今日发布，向全球开发者致敬！ ，或关注 阿里技术 微信公众号。