java-docs は何をしますか?
JavaタイプがJavadocコメントで適切に文書化され、文書化のベストプラクティスに従っていることを確認します。
説明
このスキルは、Javaコードベース内のすべての公開タイプに対してJavadocコメントが存在し、以下のベストプラクティスに準拠していることを保証します:
- すべての公開クラス、インターフェース、列挙型、アノテーションにJavadocがあること
@param、@return、@throwsタグが適切に使用されていること- 説明が簡潔で曖昧さがないこと
- HTMLタグやマークダウンが過度に使用されていないこと
使用方法
このスキルは、AIエージェント(Claude Code、Cursor、Codexなど)と連携して自動的に実行されます。
例
/**
* ユーザーアカウントを表します。
*
* @param username ユーザーの一意な名前
* @param email ユーザーのメールアドレス
*/
public record UserAccount(String username, String email) {}
プラットフォーム
- Claude Code
- Cursor
- Codex
- その他のJavadocをサポートするAIエージェント