je me demande quelles sont pour vous les informations importantes que
vous mettez lorsque vous commentez une fonctions. Par exemple, quelles
sont les balises Doxygen que vous utilisez systematiquement, et quelles
sont celles que vous mettez de temps en temps...
Cette action est irreversible, confirmez la suppression du commentaire ?
Signaler le commentaire
Veuillez sélectionner un problème
Nudité
Violence
Harcèlement
Fraude
Vente illégale
Discours haineux
Terrorisme
Autre
Stephane Wirtel
Bonjour,
je me demande quelles sont pour vous les informations importantes que vous mettez lorsque vous commentez une fonctions. Par exemple, quelles sont les balises Doxygen que vous utilisez systematiquement, et quelles sont celles que vous mettez de temps en temps...
je me demande quelles sont pour vous les informations importantes que
vous mettez lorsque vous commentez une fonctions. Par exemple, quelles
sont les balises Doxygen que vous utilisez systematiquement, et quelles
sont celles que vous mettez de temps en temps...
je me demande quelles sont pour vous les informations importantes que vous mettez lorsque vous commentez une fonctions. Par exemple, quelles sont les balises Doxygen que vous utilisez systematiquement, et quelles sont celles que vous mettez de temps en temps...
je me demande quelles sont pour vous les informations importantes que vous mettez lorsque vous commentez une fonctions. Par exemple, quelles sont les balises Doxygen que vous utilisez systematiquement, et quelles sont celles que vous mettez de temps en temps...
Ça dépend un peu de la fonction. Pour une fonction non-const, pre et post sont probablement les plus important. Pour une fonction qui ne fait que renvoie un état, en revanche, c'est clair que return est à peu près tout.
N'oublie pas non plus de documenter son comportement en cas d'erreur (exceptions levées, etc.).
Plus important que les commentaires des fonctions, souvent, c'est les commentaires des classes. Si on sait déjà le rôle et les responsibilités de la classe, et que les fonctions ont de bons noms, on arrive prèsqu'à les déviner.
-- James Kanze GABI Software Conseils en informatique orientée objet/ Beratung in objektorientierter Datenverarbeitung 9 place Sémard, 78210 St.-Cyr-l'École, France, +33 (0)1 30 23 00 34
Korchkidu wrote:
je me demande quelles sont pour vous les informations
importantes que vous mettez lorsque vous commentez une
fonctions. Par exemple, quelles sont les balises Doxygen que
vous utilisez systematiquement, et quelles sont celles que
vous mettez de temps en temps...
Ça dépend un peu de la fonction. Pour une fonction non-const,
pre et post sont probablement les plus important. Pour une
fonction qui ne fait que renvoie un état, en revanche, c'est
clair que return est à peu près tout.
N'oublie pas non plus de documenter son comportement en cas
d'erreur (exceptions levées, etc.).
Plus important que les commentaires des fonctions, souvent,
c'est les commentaires des classes. Si on sait déjà le rôle et
les responsibilités de la classe, et que les fonctions ont de
bons noms, on arrive prèsqu'à les déviner.
--
James Kanze GABI Software
Conseils en informatique orientée objet/
Beratung in objektorientierter Datenverarbeitung
9 place Sémard, 78210 St.-Cyr-l'École, France, +33 (0)1 30 23 00 34
je me demande quelles sont pour vous les informations importantes que vous mettez lorsque vous commentez une fonctions. Par exemple, quelles sont les balises Doxygen que vous utilisez systematiquement, et quelles sont celles que vous mettez de temps en temps...
Ça dépend un peu de la fonction. Pour une fonction non-const, pre et post sont probablement les plus important. Pour une fonction qui ne fait que renvoie un état, en revanche, c'est clair que return est à peu près tout.
N'oublie pas non plus de documenter son comportement en cas d'erreur (exceptions levées, etc.).
Plus important que les commentaires des fonctions, souvent, c'est les commentaires des classes. Si on sait déjà le rôle et les responsibilités de la classe, et que les fonctions ont de bons noms, on arrive prèsqu'à les déviner.
-- James Kanze GABI Software Conseils en informatique orientée objet/ Beratung in objektorientierter Datenverarbeitung 9 place Sémard, 78210 St.-Cyr-l'École, France, +33 (0)1 30 23 00 34
Korchkidu
kanze wrote:
Korchkidu wrote:
je me demande quelles sont pour vous les informations importantes que vous mettez lorsque vous commentez une fonctions. Par exemple, quelles sont les balises Doxygen que vous utilisez systematiquement, et quelles sont celles que vous mettez de temps en temps...
Ça dépend un peu de la fonction. Pour une fonction non-const, pre et post sont probablement les plus important. Pour une fonction qui ne fait que renvoie un état, en revanche, c'est clair que return est à peu près tout.
N'oublie pas non plus de documenter son comportement en cas d'erreur (exceptions levées, etc.).
Plus important que les commentaires des fonctions, souvent, c'est les commentaires des classes. Si on sait déjà le rôle et les responsibilités de la classe, et que les fonctions ont de bons noms, on arrive prèsqu'à les déviner.
Ok, merci pour vos avis.
K.
kanze wrote:
Korchkidu wrote:
je me demande quelles sont pour vous les informations
importantes que vous mettez lorsque vous commentez une
fonctions. Par exemple, quelles sont les balises Doxygen que
vous utilisez systematiquement, et quelles sont celles que
vous mettez de temps en temps...
Ça dépend un peu de la fonction. Pour une fonction non-const,
pre et post sont probablement les plus important. Pour une
fonction qui ne fait que renvoie un état, en revanche, c'est
clair que return est à peu près tout.
N'oublie pas non plus de documenter son comportement en cas
d'erreur (exceptions levées, etc.).
Plus important que les commentaires des fonctions, souvent,
c'est les commentaires des classes. Si on sait déjà le rôle et
les responsibilités de la classe, et que les fonctions ont de
bons noms, on arrive prèsqu'à les déviner.
je me demande quelles sont pour vous les informations importantes que vous mettez lorsque vous commentez une fonctions. Par exemple, quelles sont les balises Doxygen que vous utilisez systematiquement, et quelles sont celles que vous mettez de temps en temps...
Ça dépend un peu de la fonction. Pour une fonction non-const, pre et post sont probablement les plus important. Pour une fonction qui ne fait que renvoie un état, en revanche, c'est clair que return est à peu près tout.
N'oublie pas non plus de documenter son comportement en cas d'erreur (exceptions levées, etc.).
Plus important que les commentaires des fonctions, souvent, c'est les commentaires des classes. Si on sait déjà le rôle et les responsibilités de la classe, et que les fonctions ont de bons noms, on arrive prèsqu'à les déviner.
