Previous: Créer une classe Up: Programmer en Smalltalk Next: Ajouter des méthodes à une classe

Documenter une classe

Pour documenter une classe, on sélectionne dans le menu local des classes, quand la classe à documenter est sélectionnée, l'option comment. Un commentaire par défaut apparaît qui indique ce que l'on attend du commentaire. Modifier ce texte puis acceptez, la classe est commentée.

Le commentaire devrait contenir, en anglais, si possible :

1. Une description de la classe : son intention, son utilité
2. Une description des variables d'instances
3. Une description des méthodes qui doivent être surchargées
4. Toute information digne d'être citée (trucs, ...)