# java-course

**Repository Path**: li-luoqiang/java-course

## Basic Information

- **Project Name**: java-course
- **Description**: java基础教程
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-14
- **Last Updated**: 2026-08-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# java-course

java的基础教程，用于回顾知识



# 文档

 [jdk8在线文档](https://docs.oracle.com/javase/8/docs/api/)

# IDEA技巧

## 头文件注释

在 IntelliJ IDEA 中，可以通过设置**文件模板**和**活动模板**，让作者和日期信息在新建类或方法时自动生成，主要分为以下两种配置。

### 📝 1. 文件头注释（新创建类/接口自动生成）

这个配置能让 IDEA 在每次新建 Java 类、接口或枚举时，在文件顶部自动添加包含作者和时间的注释。

1. **打开设置**：点击菜单栏 `File` -> `Settings`（Mac 为 `IntelliJ IDEA` -> `Preferences`）。

2. **找到模板设置**：在设置窗口中，依次展开 `Editor` -> `File and Code Templates`。

3. **修改文件头**：在右侧面板中，选择 `Includes` 选项卡下的 `File Header`。

4. **输入模板内容**：在编辑框中输入你想要的注释模板。你可以使用 IDEA 提供的预定义变量，它们会在文件创建时被自动替换为对应的值。
   
   **示例模板**：
   
   ```java
   /**
    * @author ${USER}
    * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
    */
   ```
   
   > **变量说明**：
   > 
   > * `${USER}`：当前系统的用户名。
   > * `${YEAR}`, `${MONTH}`, `${DAY}`：当前年、月、日。
   > * `${HOUR}`, `${MINUTE}`：当前时、分。
   > * 你也可以使用 `${DATE}` 和 `${TIME}`，它们会按系统默认格式显示完整日期和时间。

5. **保存**：点击 `Apply` 和 `OK` 保存配置。之后你新建的任何 Java 类，都会自动在文件头部生成这段注释。

### ⌨️ 2. 方法注释（通过快捷键手动生成）

对于已有的方法，可以通过配置“活动模板”来快速生成带作者和时间的 Javadoc 注释。

1. **进入活动模板设置**：`File` -> `Settings` -> `Editor` -> `Live Templates`。
2. **创建模板组（可选）**：点击右侧的 `+` 号，选择 `Template Group...` 创建一个新分组，比如 `MyComments`，用于管理你的自定义模板。
3. **创建新模板**：选中你刚刚创建的组（或默认组 `user`），再次点击 `+` 号，选择 `Live Template`。
4. **配置模板内容**：
   * **Abbreviation（缩写）**：输入一个你能记住的缩写，例如 `*` 或 `add`。这是你触发注释的“关键词”。
   * **Template text（模板内容）**：输入注释的格式。这里也需要定义变量，格式为 `$变量名$`。
     **示例模板**：
     
     ```java
     /**
      * @author $user$
      * @date $date$ $time$
      * $params$
      * @return $return$
      */
     ```
   * **Define（适用范围）**：点击 `Define` 按钮，在弹窗中勾选 `Java`，确保该模板在 Java 文件中生效。
5. **设置变量值**：点击 `Edit variables` 按钮，为模板中的变量绑定 IDEA 的函数。
   * 在 `Expression` 列中，为 `date` 和 `time` 变量选择 `date()` 和 `time()` 函数。
   * `user` 变量可以设置为 `user()` 或直接填入固定用户名。
   * `params` 和 `return` 等更复杂的参数需要使用 `groovyScript` 脚本来自动生成。这个设置稍复杂，可以先从基础的日期和作者开始。
6. **保存并测试**：点击 `OK` 保存所有设置。回到代码编辑器，在一个方法上输入你设置的缩写（如 `*`），然后按下 `Tab` 键，注释就会生成。

### ⚙️ 模板配置速查表

| 模板类型       | 配置路径                                                   | 触发方式                   | 核心变量                                                  |
|:---------- |:------------------------------------------------------ |:---------------------- |:----------------------------------------------------- |
| **类/文件头**  | `Editor` -> `File and Code Templates` -> `File Header` | 创建新文件时**自动**生成         | `${USER}`, `${YEAR}`, `${MONTH}`, `${DAY}`, `${TIME}` |
| **方法/自定义** | `Editor` -> `Live Templates`                           | 输入**缩写** + `Tab` 键手动触发 | `$user$`, `$date$`, `$time$` (需绑定 `date()` 等函数)       |

如果需要为方法注释自动生成 `@param` 和 `@return`，可以参考更复杂的 `groovyScript` 脚本配置。