http://www.keru.org/article-20760355-6.html#anchorComment Les 25 derniers commentaires publiés sur l'article "Opensim : Ecrire de la doc, encore et encore." du blog "Les effervescences de kerunix" fr http://fdata.over-blog.net/1/37/44/14/avatar-blog-1014309413-tmpphp0cbhXC.png http://www.keru.org/article-20760355-6.html#anchorComment Thu, 16 Feb 2012 19:04:50 +0100 Thu, 16 Feb 2012 19:04:50 +0100 Over-blog.com RSS 2.0 Engine Copyright 2012 www.keru.org Secondlife http://www.rssboard.org/rss-specification/ http://www.keru.org/article-20760355-6.html#comment28838563 Je documente ce que je suis, à prioris, le plus apte a comprendre ;)

L'avantage de commencer par les "feuilles" plutot que des gros noeuds d'un tronc, est qu'il est moins critique de connaitre toutes les ramifications du code pour en comprendre le sens.
Alors que quand on est dans le "core", une simple ligne peut cacher des milliers de lignes de code executé, et si on comprend mal, ou on interprete mal le sens, ca peut mener a des commentaires qui sont faux, ce qui est encore pire que pas de commentaires ;)

Cela dit, je documente tout ce qui touche aux interfaces de base de donnée, ce qui est loin d'être un bout de code jamais utilisé (j'ai commencé par mysql) ;)
J'ai discuté sur l'interet de commenter l'interface MySQL qui risque de plus plus être utilisé, au profit de NHibernate, on m'a expliqué que NHibernate était loin d'etre pret et l'interface MySQL "directe" sera encore utilisée pour pas mal de temps.

Ensuite ce n'est pas si grave si le code bouge en permanence, maintenant que je me suis tapé le plus lourd de la doc pour MySQL, j'espere que les dev vont mettre à jour la doc d'eux-même. (ce qui n'est pas dur puisque la doc est directement écrite dans le code, facon Doxygen)
]]> Thu, 26 Jun 2008 08:36:50 +0200 c28c59bb84305799f61638212e08dba4 http://www.keru.org/article-20760355-6.html#comment28837765 Thu, 26 Jun 2008 08:04:58 +0200 3de1d17b3f08e643bbf1de82d9759d38