java-docs
starsforks
How to install java-docs?
ducpm2303/claude-java-plugins/java-docs
$npx -y skills add ducpm2303/claude-java-plugins --skill java-docsGenerates Javadoc comments for Java classes and methods. Use when user asks to "add javadoc", "document this class", "write documentation", "add comments", "generate docs", or "document this method".
SKILL.md
| 1 | Generate Javadoc comments for the Java code I've selected or provided. Follow standard Javadoc conventions. |
| 2 | |
| 3 | ## Rules for generating Javadoc |
| 4 | |
| 5 | **For classes and interfaces:** |
| 6 | |
| 7 | ``` |
| 8 | /** |
| 9 | * [One sentence describing the class's responsibility.] |
| 10 | * |
| 11 | * [Optional: 1–2 sentences of additional context, design pattern used, or usage note.] |
| 12 | * |
| 13 | * @author [omit — do not add @author unless already present] |
| 14 | * @since [omit unless the user specifies a version] |
| 15 | */ |
| 16 | ``` |
| 17 | |
| 18 | **For public and protected methods:** |
| 19 | |
| 20 | ``` |
| 21 | /** |
| 22 | * [One sentence describing what this method does — use active voice, e.g., "Returns the user with the given ID."] |
| 23 | * |
| 24 | * [Optional: additional detail about behaviour, side effects, or constraints — only if non-obvious.] |
| 25 | * |
| 26 | * @param paramName [description of the parameter — what it represents, valid values, null-safety] |
| 27 | * @return [description of the return value — what it contains, when it is empty/null] |
| 28 | * @throws ExceptionType [condition that causes this exception to be thrown] |
| 29 | */ |
| 30 | ``` |
| 31 | |
| 32 | **For fields:** |
| 33 | - Only document non-obvious fields with `/** brief description */` |
| 34 | - Do not document self-evident fields like `private String name;` |
| 35 | |
| 36 | ## Quality rules |
| 37 | - Do not restate the method signature in the description (e.g., avoid "This method takes a String and returns a String") |
| 38 | - Use present tense active voice: "Returns...", "Creates...", "Validates..." |
| 39 | - For `@param`: describe what the parameter represents, not just its type |
| 40 | - For `@return`: describe the returned value's meaning, not just "the result" |
| 41 | - For `@throws`: describe the condition, not just the exception name |
| 42 | - Do not add `@param` for `void` methods with no parameters |
| 43 | - Do not add `@return` for `void` methods |
| 44 | |
| 45 | ## Output |
| 46 | Produce the complete class or method with Javadoc inserted. Show only the documented code — do not change any logic. |
People who liked this also viewed
6 picksType
- grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026
- lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026
- lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026
- docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026
- edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026
