Les seuls commentaires que je mets dans du code sont:
- Un entête disant en 1-2 lignes ce qui est fait dans le fichier et listant toute les procédures/fonctions, types et variables du fichiers en précisant si elle sont visibles de l'extérieur ou non.
- Un entête pour chaque fonction listant les paramêtres en précisant ce qu'ils sont et s'ils sont modifiés, le retour et 1-2 lignes expliquant le fonctionnement de cette fonction.
Par contre dans le code pas ou trés peu de commentaire et des noms de procédures/fonctions, types et variables qui veulent dire quelques choses.
J'estime que si je n'arrive pas à décrire en 1-2 lignes le fonctionement d'un fonction, c'est que celle-ci est trop compliquée et qu'il y a un problémes de conception.
# Re: Je commente mon code :
Posté par troll hunter . En réponse au sondage Je commente mon code :. Évalué à 2.
- Un entête disant en 1-2 lignes ce qui est fait dans le fichier et listant toute les procédures/fonctions, types et variables du fichiers en précisant si elle sont visibles de l'extérieur ou non.
- Un entête pour chaque fonction listant les paramêtres en précisant ce qu'ils sont et s'ils sont modifiés, le retour et 1-2 lignes expliquant le fonctionnement de cette fonction.
Par contre dans le code pas ou trés peu de commentaire et des noms de procédures/fonctions, types et variables qui veulent dire quelques choses.
J'estime que si je n'arrive pas à décrire en 1-2 lignes le fonctionement d'un fonction, c'est que celle-ci est trop compliquée et qu'il y a un problémes de conception.