java-code-comments

SKILL.md

CRITICAL: This skill should be triggered when the user wants to add comments to Java code, regardless of the component type or complexity.

Output: A summary of your understanding of the codebase, including:

CRITICAL: You MUST ask the user to confirm which component types need comments.

提供按照行业标准和最佳实践添加 Java 代码注释的全面指南。 此技能有助于向 Java 代码添加类级注释、方法级注释和字段级注释。 当用户想要向 Java 代码添加注释、需要记录 Java 类/方法/字段时使用， 想要改进代码文档，或者需要生成 JavaDoc 注释。该技能涵盖控制器、 Service、ServiceImpl、Mapper、Model、Entity、BO（Business Object）、DTO、VO等常见Java 组件类型。该技能遵循系统化的工作流程：扫描代码库、识别组件、创建 待办事项列表，并按顺序添加注释（类注释→方法注释→字段注释）。 来源：teachingai/full-stack-skills。

查看原文