J'ai quelques remarques sur ton paragraphe à propos de la documentation.
Tu aurais pu corriger la faute: “Get the title” Il ne faut pas de s à get puisqu'il s'agit d'un impératif ou d'un infinitif — pour mettre un s il faut un sujet!
S'il y a bien un endroit (en fait, le seul!) où le copier-coller est tolérable, c'est la documentation des interfaces. C'est parfois automatisable avec des macros (comme dans les macros MDOC ou MAN pour les pages de man) mais parfois le plus court chemin est le copier-coller.
Dans ce cas la clause return … ne sert à rien car elle n'apporte pas de nouvelle information!
J'ai souvent lu ce genre de documentation pour du C ou du C++, omet l'information cruciale: la valeur de retour est-elle un alias ou une nouvelle valeur?
# Documentation
Posté par Michaël (site web personnel) . En réponse au journal De tout, de rien, des liens, bla bla bla. Évalué à 1.
J'ai quelques remarques sur ton paragraphe à propos de la documentation.
Tu aurais pu corriger la faute: “Get the title” Il ne faut pas de s à get puisqu'il s'agit d'un impératif ou d'un infinitif — pour mettre un s il faut un sujet!
S'il y a bien un endroit (en fait, le seul!) où le copier-coller est tolérable, c'est la documentation des interfaces. C'est parfois automatisable avec des macros (comme dans les macros MDOC ou MAN pour les pages de man) mais parfois le plus court chemin est le copier-coller.
Dans ce cas la clause return … ne sert à rien car elle n'apporte pas de nouvelle information!
J'ai souvent lu ce genre de documentation pour du C ou du C++, omet l'information cruciale: la valeur de retour est-elle un alias ou une nouvelle valeur?