Back to Details

java-code-comments

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

When to use this skill

何时使用此 skill

ALWAYS use this skill when the user mentions:
  • Adding comments to Java code
  • Documenting Java classes, methods, or fields
  • Generating JavaDoc comments
  • Improving code documentation
  • Code annotation or code commenting
  • 给 Java 代码添加注释
  • 生成 Java 文档注释
  • 代码注释
  • 添加注释
Trigger phrases include:
  • "给这段代码添加注释" (add comments to this code)
  • "生成 JavaDoc" (generate JavaDoc)
  • "添加类注释" (add class comments)
  • "添加方法注释" (add method comments)
  • "添加属性注释" (add field comments)
  • "代码注释" (code comments)
  • "文档注释" (documentation comments)
  • "一句话给 Java 代码添加注释" (add comments to Java code with one sentence)
Component types this skill handles:
  • Controller (REST controllers, Spring MVC controllers)
  • Service (business service interfaces)
  • ServiceImpl (service implementations)
  • Application Service (DDD application services, orchestrating domain logic)
  • Domain Service (DDD domain services, domain business logic)
  • Feign Service Interface (Feign remote service interfaces)
  • Mapper (MyBatis mappers, data access layer)
  • Model (data models, domain models)
  • Entity (JPA entities, database entities)
  • BO (Business Object, business logic objects)
  • DTO (Data Transfer Object)
  • VO (Value Object, View Object)
  • DAO (Data Access Object)
  • Repository (Spring Data repositories)
  • Configuration (Spring configuration classes)
  • Component (Spring components)
  • Utility (utility classes)
  • Exception (custom exception classes)
当用户提到以下内容时，务必使用此 skill：
  • 为 Java 代码添加注释
  • 为 Java 类、方法或字段编写文档
  • 生成 JavaDoc 注释
  • 改进代码文档
  • 代码注解或代码注释
  • 给 Java 代码添加注释
  • 生成 Java 文档注释
  • 代码注释
  • 添加注释
触发短语包括：
  • "给这段代码添加注释"（为代码添加注释）
  • "生成 JavaDoc"（生成 JavaDoc）
  • "添加类注释"（添加类注释）
  • "添加方法注释"（添加方法注释）
  • "添加属性注释"（添加字段注释）
  • "代码注释"（代码注释）
  • "文档注释"（文档注释）
  • "一句话给 Java 代码添加注释"（用一句话为 Java 代码添加注释）
此 skill 处理的组件类型：
  • Controller（REST 控制器、Spring MVC 控制器）
  • Service（业务服务接口）
  • ServiceImpl（服务实现）
  • Application Service（DDD 应用服务，负责编排领域逻辑）
  • Domain Service（DDD 领域服务，包含领域业务逻辑）
  • Feign Service Interface（Feign 远程服务接口）
  • Mapper（MyBatis Mapper、数据访问层）
  • Model（数据模型、领域模型）
  • Entity（JPA 实体、数据库实体）
  • BO（Business Object，业务逻辑对象）
  • DTO（Data Transfer Object，数据传输对象）
  • VO（Value Object、View Object，值对象、视图对象）
  • DAO（Data Access Object，数据访问对象）
  • Repository（Spring Data 仓储）
  • Configuration（Spring 配置类）
  • Component（Spring 组件）
  • Utility（工具类）
  • Exception（自定义异常类）

How to use this skill

如何使用此 skill

CRITICAL: This skill should be triggered when the user wants to add comments to Java code, regardless of the component type or complexity.
关键：无论组件类型或复杂度如何，只要用户希望添加注释，就应触发此 skill。

Workflow Overview

工作流概览

This skill follows a systematic 4-step workflow:
  1. Scan and Understand - Scan the entire codebase and related documentation to gain comprehensive understanding
  2. Confirm Component Types - Ask user to confirm which component types need comments
  3. Create Todo List - Generate a detailed todo list with class names and method names
  4. Execute Commenting - Add comments in order: class comments → method comments → field comments, updating todo list after each completion
此 skill 遵循系统化的 4 步工作流：
  1. 扫描并理解 - 扫描整个代码库及相关文档，以全面了解项目
  2. 确认组件类型 - 要求用户确认需要添加注释的组件类型
  3. 创建 Todo 列表 - 生成包含类名和方法名的详细 Todo 列表
  4. 执行注释添加 - 按顺序添加注释：类注释 → 方法注释 → 字段注释，并在每项完成后更新 Todo 列表

Step-by-Step Process

分步流程

Step 1: Scan and Understand the Codebase

第 1 步：扫描并理解代码库

CRITICAL: Before adding any comments, you MUST:
  1. Scan all Java files in the project:
    • Read all 
      .java
      files in the current directory and subdirectories
    • Understand the project structure and architecture
    • Identify relationships between classes (dependencies, inheritance, composition)
  2. Read related documentation:
    • README.md files
    • API documentation
    • Architecture documentation
    • Business requirements documents (if available)
  3. Understand the context:
    • What does each class do?
    • What is the purpose of each method?
    • What do fields represent?
    • How do components interact with each other?
  4. Identify patterns:
    • Naming conventions used in the project
    • Existing comment styles (if any)
    • Architecture patterns (MVC, DDD, etc.)
    • Framework usage (Spring, MyBatis, etc.)
Output: A summary of your understanding of the codebase, including:
  • Project structure overview
  • Key components identified
  • Architecture patterns detected
  • Existing documentation status
关键：添加任何注释之前，必须：
  1. 扫描项目中的所有 Java 文件：
    • 读取当前目录及其子目录中的所有 
      .java
      文件
    • 了解项目结构和架构
    • 识别类之间的关系（依赖、继承、组合）
  2. 阅读相关文档：
    • README.md 文件
    • API 文档
    • 架构文档
    • 业务需求文档（如果可用）
  3. 理解上下文：
    • 每个类的作用是什么？
    • 每个方法的用途是什么？
    • 各字段表示什么？
    • 各组件之间如何交互？
  4. 识别模式：
    • 项目中使用的命名约定
    • 现有注释风格（如果有）
    • 架构模式（MVC、DDD 等）
    • 使用的框架（Spring、MyBatis 等）
输出： 对代码库理解的摘要，包括：
  • 项目结构概览
  • 识别出的关键组件
  • 检测到的架构模式
  • 现有文档状态

Step 2: Confirm Component Types

第 2 步：确认组件类型

CRITICAL: You MUST ask the user to confirm which component types need comments.
Present a checklist of common Java component types and ask the user to select:
请确认需要进行代码注释的分类（可多选）：
- [ ] Controller（控制器）
- [ ] Service（服务接口）
- [ ] ServiceImpl（服务实现）
- [ ] Application Service（应用服务，DDD架构）
- [ ] Domain Service（领域服务，DDD架构）
- [ ] Feign Service Interface（Feign远程服务接口）
- [ ] Mapper（数据访问层）
- [ ] Model（数据模型）
- [ ] Entity（实体类）
- [ ] BO（业务对象）
- [ ] DTO（数据传输对象）
- [ ] VO（视图对象）
- [ ] DAO（数据访问对象）
- [ ] Repository（仓储）
- [ ] Configuration（配置类）
- [ ] Component（组件类）
- [ ] Utility（工具类）
- [ ] Exception（异常类）
- [ ] 其他（请 specify）
Also ask about comment types:
  • 类注释（Class-level comments）
  • 方法注释（Method-level comments）
  • 属性注释（Field-level comments）
Wait for user confirmation before proceeding to the next step.
关键：必须要求用户确认需要添加注释的组件类型。
呈现常见 Java 组件类型的检查清单，并要求用户选择：
请确认需要进行代码注释的分类（可多选）：
- [ ] Controller（控制器）
- [ ] Service（服务接口）
- [ ] ServiceImpl（服务实现）
- [ ] Application Service（应用服务，DDD架构）
- [ ] Domain Service（领域服务，DDD架构）
- [ ] Feign Service Interface（Feign远程服务接口）
- [ ] Mapper（数据访问层）
- [ ] Model（数据模型）
- [ ] Entity（实体类）
- [ ] BO（业务对象）
- [ ] DTO（数据传输对象）
- [ ] VO（视图对象）
- [ ] DAO（数据访问对象）
- [ ] Repository（仓储）
- [ ] Configuration（配置类）
- [ ] Component（组件类）
- [ ] Utility（工具类）
- [ ] Exception（异常类）
- [ ] 其他（请 specify）
还应询问需要的注释类型：
  • 类注释（Class-level comments）
  • 方法注释（Method-level comments）
  • 属性注释（Field-level comments）
在继续下一步之前，等待用户确认。

Step 3: Create Todo List

第 3 步：创建 Todo 列表

CRITICAL: After user confirms component types, create a detailed todo list.
For each component type selected by the user:
  1. Scan the codebase to find all matching classes:
    • Use file search to find classes matching the pattern (e.g., 
      *Controller.java
      , 
      *Service.java
      )
    • List all classes that need comments
  2. For each class, identify:
    • Class name
    • Methods that need comments
    • Fields that need comments
  3. Generate a structured todo list in the following format:
markdown
undefined
关键：用户确认组件类型后，创建详细的 Todo 列表。
对于用户选择的每种组件类型：
  1. 扫描代码库以查找所有匹配的类：
    • 使用文件搜索查找符合模式的类，例如 
      *Controller.java
      、
      *Service.java
    • 列出所有需要添加注释的类
  2. 对于每个类，识别：
    • 类名
    • 需要添加注释的方法
    • 需要添加注释的字段
  3. 按以下格式生成结构化 Todo 列表：
markdown
undefined

Todo List: Java Code Comments

Todo List: Java Code Comments

Controller 层

Controller 层

  • UserController
    • 类注释
    • createUser() - 方法注释
    • updateUser() - 方法注释
    • deleteUser() - 方法注释
    • userId - 属性注释
  • UserController
    • 类注释
    • createUser() - 方法注释
    • updateUser() - 方法注释
    • deleteUser() - 方法注释
    • userId - 属性注释

Service 层

Service 层

  • UserService
    • 类注释
    • findUserById() - 方法注释
    • saveUser() - 方法注释
  • UserService
    • 类注释
    • findUserById() - 方法注释
    • saveUser() - 方法注释

ServiceImpl 层

ServiceImpl 层

  • UserServiceImpl
    • 类注释
    • findUserById() - 方法注释
    • saveUser() - 方法注释
  • UserServiceImpl
    • 类注释
    • findUserById() - 方法注释
    • saveUser() - 方法注释

Mapper 层

Mapper 层

  • UserMapper
    • 类注释
    • selectById() - 方法注释
  • UserMapper
    • 类注释
    • selectById() - 方法注释

Model/Entity 层

Model/Entity 层

  • User
    • 类注释
    • id - 属性注释
    • username - 属性注释
    • email - 属性注释

**Important**: 
- Organize by component type
- List all classes that match the selected types
- Include all methods and fields that need comments
- Use checkboxes for tracking progress
  • User
    • 类注释
    • id - 属性注释
    • username - 属性注释
    • email - 属性注释

**重要：**
- 按组件类型组织内容
- 列出所有与所选类型匹配的类
- 包含所有需要添加注释的方法和字段
- 使用复选框跟踪进度

Step 4: Execute Commenting Work

第 4 步：执行注释添加工作

CRITICAL: Add comments in the specified order and update todo list after each completion.
Order of execution:
  1. Class-level comments (类注释) - First
  2. Method-level comments (方法注释) - Second
  3. Field-level comments (属性注释) - Third
For each item in the todo list:
  1. Process one class at a time:
    • Start with class-level comment
    • Then process all methods in that class
    • Finally process all fields in that class
    • Update the todo list after completing each class
  2. Class-level comment format (Standard JavaDoc):
    java
    /**
 * [Class description]
 * 
 * <p>This class [purpose and responsibility]
 * 
 * @author [Author name if available]
 * @since [Version or date if available]
 */
public class UserController {
    Class-level comment format (Java Coding Standards - strict):
    java
    /**
 * <p>[Class description]</p>
 * 
 * <p>This class [purpose and responsibility]</p>
 * 
 * @author [Author name if available]
 * @since [Version or date if available]
 */
public class UserController {
    Specialized class comment formats (Java Coding Standards - strict):
    Application Service:
    java
    /**
 * {服务名称}应用服务
 *
 * <p>{详细描述服务的业务功能、职责和应用场景}</p>
 * <p>主要功能包括:</p>
 * <ul>
 *   <li>{功能点1}</li>
 *   <li>{功能点2}</li>
 *   <li>{功能点3}</li>
 * </ul>
 *
 * @author system
 * @since 2025-01-21
 */
public class UserApplicationService {
    Domain Service:
    java
    /**
 * {服务名称}领域服务
 *
 * <p>{详细描述服务的领域职责和业务逻辑}</p>
 * <p>主要功能包括:</p>
 * <ul>
 *   <li>{功能点1}</li>
 *   <li>{功能点2}</li>
 * </ul>
 *
 * @author system
 * @since 2025-01-21
 */
public class UserDomainService {
    Feign Service Interface:
    java
    /**
 * {服务名称}Feign远程服务接口
 *
 * <p>通过Feign调用{目标服务}的远程接口</p>
 * <p>主要功能:</p>
 * <ul>
 *   <li>{接口功能1}</li>
 *   <li>{接口功能2}</li>
 * </ul>
 *
 * @author system
 * @since 2025-01-21
 */
public interface UserFeignService {
  3. Method-level comment format (Standard JavaDoc):
    java
    /**
 * [Method description]
 * 
 * @param [paramName] [parameter description]
 * @return [return value description]
 * @throws [ExceptionType] [exception description]
 */
public UserDTO createUser(@RequestBody UserCreateRequest request) {
    Method-level comment format (Java Coding Standards - strict):
    java
    /**
 * <p>[Method description]</p>
 * 
 * <p>[Detailed description]</p>
 * 
 * @param [paramName] [paramType] [parameter description]
 * @return [returnType] [return value description]
 * @exception [full.package.ExceptionType] [exception description]
 */
public UserDTO createUser(@RequestBody UserCreateRequest request) {
  4. Field-level comment format (Standard JavaDoc):
    java
    /**
 * [Field description]
 */
private Long userId;
    Field-level comment format (Java Coding Standards - strict):
    java
    /**
 * <p>[Field description]</p>
 * 
 * <p>[Detailed description if needed]</p>
 */
private Long userId;
  5. After completing each class:
    • Update the todo list: mark completed items with 
      [x]
    • Show progress to the user
    • Continue to the next class
Example progress update:
markdown
undefined
关键：按指定顺序添加注释，并在每项完成后更新 Todo 列表。
执行顺序：
  1. 类级注释（类注释）- 首先
  2. 方法级注释（方法注释）- 其次
  3. 字段级注释（属性注释）- 最后
对于 Todo 列表中的每一项：
  1. 每次处理一个类：
    • 从类级注释开始
    • 然后处理该类中的所有方法
    • 最后处理该类中的所有字段
    • 每个类完成后更新 Todo 列表
  2. 类级注释格式（标准 JavaDoc）：
    java
    /**
 * [Class description]
 * 
 * <p>This class [purpose and responsibility]
 * 
 * @author [Author name if available]
 * @since [Version or date if available]
 */
public class UserController {
    类级注释格式（Java 编程规范 - 严格格式）：
    java
    /**
 * <p>[Class description]</p>
 * 
 * <p>This class [purpose and responsibility]</p>
 * 
 * @author [Author name if available]
 * @since [Version or date if available]
 */
public class UserController {
    专用类注释格式（Java 编程规范 - 严格格式）：
    Application Service：
    java
    /**
 * {服务名称}应用服务
 *
 * <p>{详细描述服务的业务功能、职责和应用场景}</p>
 * <p>主要功能包括:</p>
 * <ul>
 *   <li>{功能点1}</li>
 *   <li>{功能点2}</li>
 *   <li>{功能点3}</li>
 * </ul>
 *
 * @author system
 * @since 2025-01-21
 */
public class UserApplicationService {
    Domain Service：
    java
    /**
 * {服务名称}领域服务
 *
 * <p>{详细描述服务的领域职责和业务逻辑}</p>
 * <p>主要功能包括:</p>
 * <ul>
 *   <li>{功能点1}</li>
 *   <li>{功能点2}</li>
 * </ul>
 *
 * @author system
 * @since 2025-01-21
 */
public class UserDomainService {
    Feign Service Interface：
    java
    /**
 * {服务名称}Feign远程服务接口
 *
 * <p>通过Feign调用{目标服务}的远程接口</p>
 * <p>主要功能:</p>
 * <ul>
 *   <li>{接口功能1}</li>
 *   <li>{接口功能2}</li>
 * </ul>
 *
 * @author system
 * @since 2025-01-21
 */
public interface UserFeignService {
  3. 方法级注释格式（标准 JavaDoc）：
    java
    /**
 * [Method description]
 * 
 * @param [paramName] [parameter description]
 * @return [return value description]
 * @throws [ExceptionType] [exception description]
 */
public UserDTO createUser(@RequestBody UserCreateRequest request) {
    方法级注释格式（Java 编程规范 - 严格格式）：
    java
    /**
 * <p>[Method description]</p>
 * 
 * <p>[Detailed description]</p>
 * 
 * @param [paramName] [paramType] [parameter description]
 * @return [returnType] [return value description]
 * @exception [full.package.ExceptionType] [exception description]
 */
public UserDTO createUser(@RequestBody UserCreateRequest request) {
  4. 字段级注释格式（标准 JavaDoc）：
    java
    /**
 * [Field description]
 */
private Long userId;
    字段级注释格式（Java 编程规范 - 严格格式）：
    java
    /**
 * <p>[Field description]</p>
 * 
 * <p>[Detailed description if needed]</p>
 */
private Long userId;
  5. 完成每个类后：
    • 更新 Todo 列表：使用 
      [x]
      标记已完成的项目
    • 向用户展示进度
    • 继续处理下一个类
进度更新示例：
markdown
undefined

Progress Update

Progress Update

✅ Completed: UserController
  • 类注释
  • createUser() - 方法注释
  • updateUser() - 方法注释
  • deleteUser() - 方法注释
  • userId - 属性注释
🔄 In Progress: UserService
  • 类注释
  • findUserById() - 方法注释
  • saveUser() - 方法注释
undefined
✅ Completed: UserController
  • 类注释
  • createUser() - 方法注释
  • updateUser() - 方法注释
  • deleteUser() - 方法注释
  • userId - 属性注释
🔄 In Progress: UserService
  • 类注释
  • findUserById() - 方法注释
  • saveUser() - 方法注释
undefined

Comment Quality Guidelines

注释质量指南

IMPORTANT: Comment Format Standards
This skill follows two standards:
  1. Standard JavaDoc (default): See javadoc-standards.md (within this skill)
  2. Java Coding Standards (strict): See java-coding-standards.md (within this skill)
The Java Coding Standards require:
  • Description must be wrapped in 
    <p>
    tags    : 
    <p>description</p>
  • Parameter types must be declared: 
    @param paramName paramType description
  • Return types must be declared: 
    @return returnType description
  • Exception types must be declared with full package name: 
    @exception java.lang.Exception description
Class Comments Should Include:
  • Clear description of the class purpose (wrapped in 
    <p>
    tags if following Java Coding Standards)
  • Main responsibilities
  • Usage examples (if complex)
  • Related classes or components
  • Author and version (if available)
Method Comments Should Include:
  • Clear description of what the method does (wrapped in 
    <p>
    tags if following Java Coding Standards)
  • All parameters with descriptions and types
  • Return value description with type
  • Exceptions that may be thrown (with full package names)
  • Usage examples (for complex methods)
  • Side effects (if any)
Field Comments Should Include:
  • Clear description of what the field represents (wrapped in 
    <p>
    tags if following Java Coding Standards)
  • Data type and constraints (if applicable)
  • Default values (if applicable)
  • Relationships to other fields (if applicable)
重要：注释格式标准
此 skill 遵循两项标准：
  1. 标准 JavaDoc（默认）：请参阅 javadoc-standards.md（位于此 skill 内）
  2. Java 编程规范（严格格式）：请参阅 java-coding-standards.md（位于此 skill 内）
Java 编程规范要求：
  • 描述必须使用 
    <p>
    标签包裹    ：
    <p>description</p>
  • 必须声明参数类型：
    @param paramName paramType description
  • 必须声明返回类型：
    @return returnType description
  • 异常类型必须使用完整包名声明：
    @exception java.lang.Exception description
类注释应包含：
  • 清晰描述类的用途（如果遵循 Java 编程规范，则使用 
    <p>
    标签包裹）
  • 主要职责
  • 使用示例（如果类较为复杂）
  • 相关类或组件
  • 作者和版本（如果可用）
方法注释应包含：
  • 清晰描述方法的功能（如果遵循 Java 编程规范，则使用 
    <p>
    标签包裹）
  • 所有参数及其描述和类型
  • 带类型的返回值描述
  • 可能抛出的异常（使用完整包名）
  • 使用示例（对于复杂方法）
  • 副作用（如果有）
字段注释应包含：
  • 清晰描述字段表示的内容（如果遵循 Java 编程规范，则使用 
    <p>
    标签包裹）
  • 数据类型和约束（如果适用）
  • 默认值（如果适用）
  • 与其他字段的关系（如果适用）

Best Practices

最佳实践

  1. Be concise but complete: Comments should be clear and informative without being verbose
  2. Use JavaDoc format: Follow standard JavaDoc conventions
  3. Maintain consistency: Use consistent style across all comments
  4. Update todo list: Always update the todo list after completing each item
  5. One class at a time: Process one complete class before moving to the next
  6. Respect existing code: Don't modify code logic, only add comments
  7. Context-aware: Comments should reflect the actual code behavior and business context
  1. 简洁但完整：注释应清晰且信息充分，避免过于冗长
  2. 使用 JavaDoc 格式：遵循标准 JavaDoc 约定
  3. 保持一致性：所有注释使用统一的风格
  4. 更新 Todo 列表：完成每项工作后始终更新 Todo 列表
  5. 每次处理一个类：处理完一个完整的类后再继续下一个
  6. 尊重现有代码：不修改代码逻辑，只添加注释
  7. 具备上下文感知能力：注释应反映实际代码行为和业务上下文

Comment Templates

注释模板

For different component types, use appropriate templates from the 
templates/
directory:
  • templates/controller-comment-template.md
    - Controller class comments
  • templates/service-comment-template.md
    - Service interface comments
  • templates/serviceimpl-comment-template.md
    - Service implementation comments
  • templates/application-service-comment-template.md
    - Application Service comments (DDD)
  • templates/domain-service-comment-template.md
    - Domain Service comments (DDD)
  • templates/feign-service-comment-template.md
    - Feign Service Interface comments
  • templates/mapper-comment-template.md
    - Mapper comments
  • templates/entity-comment-template.md
    - Entity class comments
  • templates/dto-comment-template.md
    - DTO class comments
针对不同组件类型，使用 
templates/
目录中的相应模板：
  • templates/controller-comment-template.md
    - Controller 类注释
  • templates/service-comment-template.md
    - Service 接口注释
  • templates/serviceimpl-comment-template.md
    - Service 实现类注释
  • templates/application-service-comment-template.md
    - Application Service 注释（DDD）
  • templates/domain-service-comment-template.md
    - Domain Service 注释（DDD）
  • templates/feign-service-comment-template.md
    - Feign Service Interface 注释
  • templates/mapper-comment-template.md
    - Mapper 注释
  • templates/entity-comment-template.md
    - Entity 类注释
  • templates/dto-comment-template.md
    - DTO 类注释

Comment Standards Reference

注释标准参考

Note: All reference documents are located within this skill's directory structure.
  • Standard JavaDoc: See reference/javadoc-standards.md (local reference)
  • Java Coding Standards (strict format): See reference/java-coding-standards.md (local reference)
When to use Java Coding Standards format:
  • When the project explicitly follows 《JAVA 编程规范》
  • When the project requires strict format with 
    <p>
    tags for descriptions
  • When parameter and return types must be explicitly declared in comments
注意：所有参考文档均位于此 skill 的目录结构中。
  • 标准 JavaDoc：请参阅 reference/javadoc-standards.md（本地参考）
  • Java 编程规范（严格格式）：请参阅 reference/java-coding-standards.md（本地参考）
何时使用 Java 编程规范格式：
  • 项目明确遵循《JAVA 编程规范》时
  • 项目要求严格使用 
    <p>
    标签包裹描述时
  • 注释中必须明确声明参数和返回类型时

Examples

示例

See the 
examples/
directory for complete examples:
  • examples/controller-example.md
    - Controller commenting example
  • examples/service-example.md
    - Service commenting example
  • examples/entity-example.md
    - Entity commenting example
  • examples/full-workflow-example.md
    - Complete workflow example
请参阅 
examples/
目录中的完整示例：
  • examples/controller-example.md
    - Controller 注释示例
  • examples/service-example.md
    - Service 注释示例
  • examples/entity-example.md
    - Entity 注释示例
  • examples/full-workflow-example.md
    - 完整工作流示例

Keywords

关键词

English keywords: java, code comments, javadoc, documentation, class comments, method comments, field comments, code annotation, code documentation, java documentation, add comments, generate comments, document code, code comments java, java code comments, controller comments, service comments, mapper comments, entity comments, dto comments
Chinese keywords (中文关键词): Java 代码注释, 添加注释, 生成注释, 代码注释, 文档注释, JavaDoc, 类注释, 方法注释, 属性注释, 字段注释, 给代码添加注释, 代码文档, Java 文档, 注释生成, 一句话添加注释, Controller 注释, Service 注释, Mapper 注释, Entity 注释, DTO 注释, 代码注解
英文关键词： java, code comments, javadoc, documentation, class comments, method comments, field comments, code annotation, code documentation, java documentation, add comments, generate comments, document code, code comments java, java code comments, controller comments, service comments, mapper comments, entity comments, dto comments
中文关键词： Java 代码注释, 添加注释, 生成注释, 代码注释, 文档注释, JavaDoc, 类注释, 方法注释, 属性注释, 字段注释, 给代码添加注释, 代码文档, Java 文档, 注释生成, 一句话添加注释, Controller 注释, Service 注释, Mapper 注释, Entity 注释, DTO 注释, 代码注解

常见陷阱 (Gotchas)

常见注意事项（Gotchas）

  1. 版本兼容性：注意框架版本与依赖库的兼容性，不同版本 API 可能有差异
  2. 配置文件格式：配置文件格式错误是最常见的问题，建议使用编辑器的语法检查
  3. 环境变量：确保所有必要的环境变量已正确设置，敏感信息不要硬编码
  4. 依赖冲突：多版本共存时注意依赖冲突，使用 lock 文件锁定版本
  5. 性能陷阱：大数据量场景下注意性能优化，避免 N+1 查询等常见问题
  1. 版本兼容性：注意框架版本与依赖库的兼容性，不同版本的 API 可能存在差异
  2. 配置文件格式：配置文件格式错误是最常见的问题，建议使用编辑器的语法检查
  3. 环境变量：确保所有必要的环境变量均已正确设置，敏感信息不要硬编码
  4. 依赖冲突：多版本共存时注意依赖冲突，使用 lock 文件锁定版本
  5. 性能陷阱：在大数据量场景下注意性能优化，避免 N+1 查询等常见问题