Zum Hauptinhalt springen
Dieser Inhalt ist noch nicht in Ihrer Sprache verfügbar und wird auf Englisch angezeigt.

Java Docs

Skill Verifiziert Aktiv

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

Zweck

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

Funktionen

  • 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

Anwendungsfälle

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

Nicht-Ziele

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

Installation

npx skills add github/awesome-copilot

Führt das Vercel skills CLI (skills.sh) via npx aus — benötigt Node.js lokal und mindestens einen installierten skills-kompatiblen Agent (Claude Code, Cursor, Codex, …). Setzt voraus, dass das Repo dem agentskills.io-Format folgt.

Qualitätspunktzahl

Verifiziert
99 /100
Analysiert 1 day ago

Vertrauenssignale

Letzter Commit1 day ago
Sterne32.9k
LizenzMIT
Status
Quellcode ansehen

Ähnliche Erweiterungen