Ce n'est pas du commentaire de code, mais de la documentation d'API.
Un commentaire de code est là pour aider à celui qui lis le code. Il lui indique pourquoi les choses sont faites de cette façon (quand le code ne peux pas l'indiquer de lui même).
La documentation d'une API décris ce que fait l'API sans avoir besoin d'aller en lire le code. Pas mal d'éditeurs ter permettent d'y accéder sans aller voir le code. Très pratique quand tu veux entrer les paramètres d'une méthode en gardant la doc sous les yeux (ça évite les sauts qui, aussi rapides et efficaces qu'ils soient, obliger à repositionner ton regard.
[^] # Re: No comment
Posté par barmic 🦦 . En réponse au journal Toileharicot 12 est dehors. Évalué à 9.
Ce n'est pas du commentaire de code, mais de la documentation d'API.
Un commentaire de code est là pour aider à celui qui lis le code. Il lui indique pourquoi les choses sont faites de cette façon (quand le code ne peux pas l'indiquer de lui même).
La documentation d'une API décris ce que fait l'API sans avoir besoin d'aller en lire le code. Pas mal d'éditeurs ter permettent d'y accéder sans aller voir le code. Très pratique quand tu veux entrer les paramètres d'une méthode en gardant la doc sous les yeux (ça évite les sauts qui, aussi rapides et efficaces qu'ils soient, obliger à repositionner ton regard.
Donc moi ça me choc pas.
https://linuxfr.org/users/barmic/journaux/y-en-a-marre-de-ce-gros-troll