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.

원본 보기