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 コンポーネントの種類。このスキルは、コードベースのスキャン、コンポーネントの特定、作成という体系的なワークフローに従います。 todoリストを作成し、順番にコメントを追加します（クラスコメント→メソッドコメント→フィールドコメント）。 ソース: teachingai/full-stack-skills。

原文を見る