Skip to main content

add-javadoc

Add comprehensive JavaDoc documentation to Java classes and methods. Use when documenting Java code, adding API documentation, or improving code documentation.

소스 정보

저장소
OpenHands/extensions
최근 소스 활동
2026년 4월 23일 20:19
감지된 SKILL.md 언어
영어
스타
167
포크
114

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

파일 탐색기
6 개 파일

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
add-javadoc
description
Add comprehensive JavaDoc documentation to Java classes and methods. Use when documenting Java code, adding API documentation, or improving code documentation.
license
MIT
compatibility
Requires Java source files
triggers
["javadoc","java documentation","document java"]
Add comprehensive JavaDoc documentation to all public classes and methods. ## Class-Level Documentation For each public class: - Add class-level JavaDoc describing the purpose and responsibility of the class - Include `@author` tag if appropriate ## Method-Level Documentation For each public method: - Add method-level JavaDoc describing what the method does - Include `@param` tags for all parameters with clear descriptions - Include `@return` tag describing the return value - Include `@throws` tags for any checked exceptions ## Style Guidelines - First sentence should be a concise summary - Use HTML tags sparingly (prefer plain text) - Document preconditions and postconditions when relevant - Include code examples with `{@code ...}` for complex methods See [references/example.md](references/example.md) for before/after examples.
GitHub에서 보기