pas de commentaire sur un get_date()
Faut voir. Par exemple je vois une fonction get_date() dans une API sans commenataire je pose quelques questions :
- Est-ce que la fonction peut revoyer NULL ?
- Est-ce qu'elle revoie une date par défaut ? le 1/1/70 ou la date d'aujourd'hui ?
- Est-ce qu'elle renvoie des codes d'erreur ou des exceptions ? dans quels cas ?
- Est-ce que ka date retournée utilise la TimeZone de la machine ou une TimeZone par défaut ?
Bien sûr ces questions sont bien souvent des faux problèmes, surtout le coup de la TimeZone. En fait, pour écrire des commentaires, le programmeur doit se mettre à la place de celui qui lira le code sans l'avoir écrit (contributeur, débuggeur, développeur d'une application tierce ou d'un plugin utilisant l'API...) et ce n'est pas facile de se dire que tel ou tel commentaire est inutile ou alors indispensable quand on a pas le recul.
[^] # Re: Je commente mon code :
Posté par jcs (site web personnel) . En réponse au sondage Je commente mon code :. Évalué à 1.
Faut voir. Par exemple je vois une fonction get_date() dans une API sans commenataire je pose quelques questions :
- Est-ce que la fonction peut revoyer NULL ?
- Est-ce qu'elle revoie une date par défaut ? le 1/1/70 ou la date d'aujourd'hui ?
- Est-ce qu'elle renvoie des codes d'erreur ou des exceptions ? dans quels cas ?
- Est-ce que ka date retournée utilise la TimeZone de la machine ou une TimeZone par défaut ?
Bien sûr ces questions sont bien souvent des faux problèmes, surtout le coup de la TimeZone. En fait, pour écrire des commentaires, le programmeur doit se mettre à la place de celui qui lira le code sans l'avoir écrit (contributeur, débuggeur, développeur d'une application tierce ou d'un plugin utilisant l'API...) et ce n'est pas facile de se dire que tel ou tel commentaire est inutile ou alors indispensable quand on a pas le recul.