跳转到主要内容
此内容尚未提供您的语言版本,正在以英文显示。

Java Docs

技能 已验证 活跃

Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.

目的

Ensure that Java code is well-documented with Javadoc comments, adhering to best practices for clarity and maintainability.

功能

  • Enforces Javadoc for public/protected members
  • Provides guidance on documenting private members
  • Details usage of Javadoc tags (@param, @return, @throws, @see, etc.)
  • Explains handling of generic types and deprecation

使用场景

  • Improving code maintainability through consistent documentation
  • Ensuring adherence to project-specific Javadoc standards
  • Assisting developers in writing clear and effective Javadoc comments

非目标

  • Generating Javadoc comments automatically without developer input
  • Enforcing documentation for non-Java code

安装

npx skills add github/awesome-copilot

通过 npx 运行 Vercel skills CLI(skills.sh)— 需要本地安装 Node.js,以及至少一个兼容 skills 的智能体(Claude Code、Cursor、Codex 等)。前提是仓库遵循 agentskills.io 格式。

质量评分

已验证
99 /100
1 day ago 分析

信任信号

最近提交1 day ago
星标32.9k
许可证MIT
状态
查看源代码