Commentaire

Introduction

Les commentaires sont une partie très importante de l'écriture de code. Elle permette aux programmeurs d'organiser le code et leurs idées, d'indiquer aux autres programmeurs ce que le code fait, d'expliquer des complexités dans le code et même de générer de la documentation.

Vous utiliserez les commentaires aux endroits suivants:

• Au-dessus des classes.
• Au-dessus des fonctions.
• Au-dessus de tout code plus complexe.
• Au-dessus d'une section devant être organisée.

Commentaire de classes et fonctions

Chaque classe et fonction dans votre code doit obligatoirement être précédé d'un commentaire expliquant ce que cette classe ou fonction fait. Nous verrons plus de détails sur ces commentaires dans les modules suivants puisqu'ils peuvent être utilisé pour générer de la documentation. Toutefois, nous n'irons pas aussi loin dans le module présent.

Code complexe

N'importe quel code complexe qui n'est pas évident à comprendre à coup d'oeil rapide devrait être précédé d'un commentaire expliquant son comportement. Si vous travaillez avec des collègues de travail, ils seront content d'avoir une explication s'ils ont besoin de travailler dans ce code. Même si vous travaillez seul, vous du futur sera content d'avoir une explication au code complexe écrit dans le passé.

Organisation de code

Les commentaires peuvent aussi servir à classer différentes sections du code. Vous verrez souvent ce style de commentaire dans de vieux et très volumineux fichiers de code ou dans des . Ces commentaires servent généralement à donner un titre à une section de code.