Documentation des classes
Description d'une classe
Le commentaire de documentation d'une classe doit se retrouver juste au dessus de la déclaration d'une classe. Ce commentaire doit essentiellement contenir une description de ce que représente la classe, un court résumé de ses différentes fonctionnalités ainsi que des explications de comment l'utiliser si la classe est complexe.
Exemples
Un commentaire de classe pourrait ressembler à ceci:
C#
Java
Javascript