github/java-docs

Que fait java-docs ?

Garantit que les types Java sont documentés avec des commentaires Javadoc et respectent les bonnes pratiques de documentation.

Description

Cette compétence permet à un agent IA d'analyser des fichiers source Java et de vérifier que tous les types publics (classes, interfaces, énumérations, annotations) sont correctement documentés avec des commentaires Javadoc. Elle suit les conventions de documentation standard de Java (Oracle).

Utilisation

# Exemple d'utilisation avec un agent comme Claude Code ou Cursor
# L'agent analysera le code source et identifiera les types manquants de documentation.

Fonctionnement

1. L'agent inspecte les fichiers .java dans le projet.
2. Pour chaque type public, il vérifie la présence d'un commentaire Javadoc.
3. Si un type est manquant ou incomplet, il propose une documentation appropriée.
4. La documentation inclut une description du type, les paramètres génériques (@param <T>) et les dépendances (@see).

Exemple de sortie

/**
 * Représente un utilisateur dans le système.
 *
 * @param <T> le type d'identifiant de l'utilisateur
 * @see UserService
 */
public class User<T> {
    // ...
}

Plateformes supportées

• Claude Code
• Cursor
• Codex
• Tout agent compatible avec des compétences GitHub

Notes

• Les types privés ou internes ne sont pas vérifiés.
• Les méthodes et champs ne sont pas inclus dans cette vérification (se concentre sur les types).