Java 笔记 03：Java 基础知识，使用 IDEA 创建 Java 项目、设置注释颜色，以及自动生成 JavaDoc

一、前言

记录时间 [2024-04-21]

系列文章简摘：
Java 笔记 01：Java 概述，MarkDown 常用语法整理
Java 笔记 02：Java 开发环境的搭建，IDEA / Notepad++ / JDK 安装及环境配置，编写第一个 Java 程序

本文讲述了一些 Java 基础知识，包括注释、标识符、关键字等。也讲述了如何使用 IDEA 创建 Java 项目，如何搭建运行环境，以及在 IDEA 中如何编写 Java程序。还有 IDEA 中设置注释的字体颜色，IDEA 在创建 Java 类时自动生成 JavaDoc 的方式。

二、准备工作

1. 创建空的项目

在 IDEA 中创建一个 Java 项目用于 Java 基础的学习。

创建一个空项目：File ==> New ==> Project ==> Empty Project ==> Next ==> Finish

项目保存位置自行决定。

2. 创建 Java 模块

新建 Java 模块 Module：File ==> New ==> Module ==> Java ==> Next ==> Finish

笔者给模块取名为：BaseUse

3. 设置 SDK 和 Language

设置 SDK 和 Language：File ==> Project Structure ==> Project ==> SDK 1.8 ==> Language 8 ==> Apply

4. 测试环境

在 BaseUse 模块的 src 目录下新建 Java 文件，运行一个 HelloWorld，检测环境是否搭建完毕。

src 目录下：New ==> Java Class ==> HelloWorld

编写测试代码：

public class HelloWorld {

    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
    
}

右键运行，选择 run "HelloWorld.main()"，可以看到，IDEA 下方控制台输出了 Hello, World!

项目环境正常。

三、注释

随着项目结构变得复杂，代码量开始增多，我们需要使用注释，不然的话，写的东西过几天就忘记了，而且也不利于团队协作。
注释不会被 Java 程序执行，是给写代码的人看的，从现在开始就养成书写注释的好习惯吧！

写注释非常重要，平时写代码要注意规范。

1. 注释的三种分类

• 单行注释
• 多行注释
• 文档注释

---

单行注释

单行注释用两个斜杠表示，后面可以写一行文字。

例如：

// 单行注释：注释一行文字
// 输出一个 Hello, World!

---

多行注释

多行注释可以注释一段文字，写好几行的那种，首尾用 /* */ 表示。

例如：

/* 多行注释：注释一段文字  */
/*
	我是多行注释
	我是多行注释
	我是多行注释
*/

---

文档注释 JavaDoc

文档注释是 /** 开头，*/ 结尾，注意区别多行注释。文档注释一般使用得比较少。

文档注释可以添加参数，且参数会被识别。

例如：@Description 添加描述；@Author 添加作者。

/**
 * @Description Hello, World!
 * @Author yuanyuan
 */

2. 有趣的代码注释

笔者从网上搜集了一些有趣的 Java 代码注释，挑了几个喜欢的整理在下方了，感兴趣的朋友可以了解了解。

注意下方代码注释是从网上搜集的啊。

/**
 *                    _ooOoo_
 *                   o8888888o
 *                   88" . "88
 *                   (| -_- |)
 *                    O\ = /O
 *                ____/`---'\____
 *              .   ' \\| |// `.
 *               / \\||| : |||// \
 *             / _||||| -:- |||||- \
 *               | | \\\ - /// | |
 *             | \_| ''\---/'' | |
 *              \ .-\__ `-` ___/-. /
 *           ___`. .' /--.--\ `. . __
 *        ."" '< `.___\_<|>_/___.' >'"".
 *       | | : `- \`.;`\ _ /`;.`/ - ` : | |
 *         \ \ `-. \_ __\ /__ _/ .-` / /
 * ======`-.____`-.___\_____/___.-`____.-'======
 *                    `=---='
 *
 * .............................................
 *          佛祖保佑             永无BUG
 */


/**
 * _ooOoo_
 * o8888888o
 * 88" . "88
 * (| -_- |)
 *  O\ = /O
 * ___/`---'\____
 * .   ' \\| |// `.
 * / \\||| : |||// \
 * / _||||| -:- |||||- \
 * | | \\\ - /// | |
 * | \_| ''\---/'' | |
 * \ .-\__ `-` ___/-. /
 * ___`. .' /--.--\ `. . __
 * ."" '< `.___\_<|>_/___.' >'"".
 * | | : `- \`.;`\ _ /`;.`/ - ` : | |
 * \ \ `-. \_ __\ /__ _/ .-` / /
 * ======`-.____`-.___\_____/___.-`____.-'======
 * `=---='
 *          .............................................
 *           佛曰：bug泛滥，我已瘫痪！
 */

/**
 * http://www.flvcd.com/
 *  .--,       .--,
 * ( (  \.---./  ) )
 *  '.__/o   o\__.'
 *     {=  ^  =}
 *      >  -  <
 *     /       \
 *    //       \\
 *   //|   .   |\\
 *   "'\       /'"_.-~^`'-.
 *      \  _  /--'         `
 *    ___)( )(___
 *   (((__) (__)))    高山仰止,景行行止.虽不能至,心向往之。
 */

/**
 * ░░░░░░░░░░░░░░░░░░░░░░░░▄░░
 * ░░░░░░░░░▐█░░░░░░░░░░░▄▀▒▌░
 * ░░░░░░░░▐▀▒█░░░░░░░░▄▀▒▒▒▐
 * ░░░░░░░▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐
 * ░░░░░▄▄▀▒░▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐
 * ░░░▄▀▒▒▒░░░▒▒▒░░░▒▒▒▀██▀▒▌
 * ░░▐▒▒▒▄▄▒▒▒▒░░░▒▒▒▒▒▒▒▀▄▒▒
 * ░░▌░░▌█▀▒▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐
 * ░▐░░░▒▒▒▒▒▒▒▒▌██▀▒▒░░░▒▒▒▀▄
 * ░▌░▒▄██▄▒▒▒▒▒▒▒▒▒░░░░░░▒▒▒▒
 * ▀▒▀▐▄█▄█▌▄░▀▒▒░░░░░░░░░░▒▒▒
 * 单身狗就这样默默地看着你，一句话也不说。
 */

/**
 *      ┌─┐       ┌─┐
 *   ┌──┘ ┴───────┘ ┴──┐
 *   │                 │
 *   │       ───       │
 *   │  ─┬┘       └┬─  │
 *   │                 │
 *   │       ─┴─       │
 *   │                 │
 *   └───┐         ┌───┘
 *       │         │
 *       │         │
 *       │         │
 *       │         └──────────────┐
 *       │                        │
 *       │                        ├─┐
 *       │                        ┌─┘
 *       │                        │
 *       └─┐  ┐  ┌───────┬──┐  ┌──┘
 *         │ ─┤ ─┤       │ ─┤ ─┤
 *         └──┴──┘       └──┴──┘
 *                神兽保佑
 *               代码无BUG!
 */


/**
 *      ┌─┐       ┌─┐
 *   ┌──┘ ┴───────┘ ┴──┐
 *   │                 │
 *   │       ───       │
 *   │   >        <    │
 *   │                 │
 *   │   ...  ⌒  ...   │
 *   │                 │
 *   └───┐         ┌───┘
 *       │         │
 *       │         │
 *       │         │
 *       │         └──────────────┐
 *       │                        │
 *       │                        ├─┐
 *       │                        ┌─┘
 *       │                        │
 *       └─┐  ┐  ┌───────┬──┐  ┌──┘
 *         │ ─┤ ─┤       │ ─┤ ─┤
 *         └──┴──┘       └──┴──┘
 *                神兽保佑
 *               代码无BUG!
 */


/**
 *      ┌─┐       ┌─┐ + +
 *   ┌──┘ ┴───────┘ ┴──┐++
 *   │                 │
 *   │       ───       │++ + + +
 *   ███████───███████ │+
 *   │                 │+
 *   │       ─┴─       │
 *   │                 │
 *   └───┐         ┌───┘
 *       │         │
 *       │         │   + +
 *       │         │
 *       │         └──────────────┐
 *       │                        │
 *       │                        ├─┐
 *       │                        ┌─┘
 *       │                        │
 *       └─┐  ┐  ┌───────┬──┐  ┌──┘  + + + +
 *         │ ─┤ ─┤       │ ─┤ ─┤
 *         └──┴──┘       └──┴──┘  + + + +
 *                神兽保佑
 *               代码无BUG!
 */

3. IDEA 设置注释颜色

IDEA 修改注释字体颜色方法：File ==> Settings ==> Editor ==> Color Scheme ==> Java ==> Comments

如图所示：给三种注释分别修改字体颜色。

4. IDEA 自动生成 JavaDoc

如果想要 IDEA 在创建 Java 类时，自动生成作者、时间等信息，那就进行如下设置。

File ==> Settings ==> Editor ==> File and Code Templates ==> Includes ==> File Header

示意图如下：

JavaDoc 参考模板如下：

//	模板

/**
 * @author ${USER}
 * @data ${DATE} ${TIME}
 * @version 1.0
 */

四、标识符和关键字

1. 关键字

回看我们之前写的 HelloWorld 程序：

• HelloWorld：类名，文件名
• public / class / static：关键字

public class HelloWorld {

    public static void main(String[] args) {
        
        String variable_name = "变量名";
        
        System.out.println("Hello, World!");
    }
    
}

---

在 Java 程序中，不能使用关键字命名！比如，不能使用 class 作为文件名。

Java 中的关键字主要有如下这些：

abstract	assert	boolean	break	byte
case	catch	char	class	const
continue	default	do	double	else
enum	extends	final	finally	float
for	goto	if	implements	import
instanceof	int	interface	long	native
new	package	private	protected	public
return	strictfp	short	static	super
switch	synchronized	this	throw	throws
transient	try	void	volatile	while

2. 标识符

Java 所有的组成部分都需要名字。类名、变量名以及方法名都被称为标识符。

（对照 HelloWorld 程序）

• 类名：HelloWorld
• 变量名：variable_name
• 方法名：main

3. 注意事项

• 所有的标识符的首字符都是字母（A - Z 或者 a - z），美元符（ $ ）、或者下划线 （ _ ）；
• 首字符之后可以使用字母、美元符、下划线或数字，这四种字符的任意组合；
• 不能使用关键字作为变量名或方法名；
• Java 是强类型语言，标识符是大小写敏感的
• 可以使用中文命名，但是一般不建议，也不建议使用拼音

合法标识符举例：

// 合法标识符 字母开头
age
String Ahello = "user";
String hello = "user";
    
// 合法标识符 美元符开头
$salary_value
String $hello = "user";

// 合法标识符 下划线开头
__1_value
String _hello = "user";

非法标识符举例：

// 非法标识符 数字开头
123abc
    
// 非法标识符 段横杠开头
-salary
    
// 非法标识符 # 号开头
#abc

五、总结

本文讲述了一些 Java 基础知识，包括注释、标识符、关键字等。也讲述了如何使用 IDEA 创建 Java 项目，如何搭建运行环境，以及在 IDEA 中如何编写 Java程序。还有 IDEA 中设置注释的字体颜色，IDEA 在创建 Java 类时自动生成 JavaDoc 的方式。

一些参考资料

狂神说 Java 零基础：https://www.bilibili.com/video/BV12J41137hu/
TIOBE 编程语言走势： https://www.tiobe.com/tiobe-index/
Typora 官网：https://www.typoraio.cn/
Oracle 官网：https://www.oracle.com/
Notepad++ 下载地址：https://notepad-plus.en.softonic.com/
IDEA 官网：https://www.jetbrains.com.cn/idea/