Notre avis
Génère une documentation KDoc concise pour les classes et fonctions Kotlin, en se concentrant sur les résumés essentiels et en ignorant les déclarations triviales ou évidentes.
Points forts
- Applique un style minimaliste cohérent pour la documentation KDoc
- Évite le bruit en ignorant les propriétés, membres privés et accesseurs
- Se concentre uniquement sur la documentation de l'API publique
- Respecte les bonnes pratiques KDoc avec des résumés commençant par un verbe
Limites
- Ne documente pas les fonctions privées ou internes, ce qui peut être nécessaire dans certains projets
- Peut ne pas décrire les valeurs de retour complexes si le nom de la fonction est explicite
- La décision de sauter des fonctions évidentes peut être subjective
Quand vous souhaitez ajouter rapidement une documentation KDoc standard aux fichiers Kotlin sans rédaction manuelle exhaustive.
Quand vous avez besoin d'une documentation complète incluant tous les paramètres, exceptions et informations de version.
Analyse de sécurité
SûrThe skill only reads and edits Kotlin files using safe tools (Read, Edit, Glob, Grep). It does not execute any code, network requests, or system commands. There is no risk of data exfiltration, destruction, or safety bypass.
Aucun point d'attention détecté
Exemples
Add KDoc to the Kotlin file src/main/kotlin/com/example/GameManager.ktWrite KDoc for the AuthService interface and its methods in AuthService.ktCheck if there are any undocumented public functions in the PlayerRepository.kt file and add KDoc to themname: kdoc description: Write concise KDoc documentation for Kotlin classes and functions. Use when user wants to add KDoc to Kotlin files. Focuses on short summaries without version info or variable docs. allowed-tools:
- Read
- Edit
- Glob
- Grep
KDoc Documentation Writer
Write short, concise KDoc documentation for Kotlin files focusing on class and function summaries only.
Rules
-
Class/Interface/Object KDoc
- Single sentence describing purpose
- No
@author,@version,@since, or other metadata - No
@propertyfor class properties
-
Function KDoc
- One-liner summary of what function does
@paramonly if parameter purpose isn't obvious from name@returnonly if return value needs clarification- Skip
@throwsunless critical for API consumers
-
DO NOT Document
- Variables/properties (neither class nor local)
- Private functions (unless complex logic)
- Getters/setters
- Obvious functions (e.g.,
fun getId(): String) - Companion object members
-
Style
- Start with verb (Returns, Creates, Handles, Processes)
- No period at end of single-line KDoc
- Max 80 chars per line
- Use
/** ... */format
Examples
Class KDoc
/** Manages game session state and lifecycle */
class GameManager { ... }
/** Handles user authentication via OAuth and email */
interface AuthService { ... }
Function KDoc
/** Loads questions from remote API and caches locally */
suspend fun loadQuestions(): List<Question>
/** @param difficulty Filter questions by difficulty level */
fun getQuestionsByDifficulty(difficulty: Difficulty): List<Question>
/**
* Validates answer and updates score
* @return true if answer correct
*/
fun submitAnswer(questionId: String, answer: String): Boolean
Skip These
// NO KDoc needed
private fun calculateInternalScore(): Int
val currentScore: Int
fun getUsername(): String
companion object { const val TAG = "Game" }
Workflow
- Read target Kotlin file
- Identify public classes, interfaces, objects
- Identify public/internal functions needing docs
- Write minimal KDoc using Edit tool
- Skip variables, private members, obvious code
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Décision de Pivot Stratégique
Documentation
Documente une décision stratégique de pivot ou de persévérance avec preuves, analyse et justification. À utiliser pour évaluer s'il faut changer de cap sur un produit, une fonctionnalité ou une stratégie en fonction des retours du marché.