Writing Javadoc

Use this skill to write concise, contract-focused Javadoc that matches the surrounding Java code, tests, and project style.

Core Rules

Write Javadocs in Korean. Keep Java identifiers, API names, tags, and code literals in their original form.
Do not return example code or generate usage examples.
Do not add new @author, @version, or @since tags.
Preserve existing @author, @version, and @since tags when revising existing Javadocs unless the user explicitly asks to remove them.
Document public and protected members when their contract is useful to callers.
Document package-private and private members only when the behavior is complex, non-obvious, or intentionally differs from nearby public methods.
Do not generate boilerplate documentation for simple fields or type member properties.
Keep documentation close to the code's actual behavior and tested contract.