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/agent-skills。

查看原文