Documentation du code pour le développeur

La section dediée aux développeurs. Coders forum section.

Modérateur: christoph

Documentation du code pour le développeur

Messagepar Rui Serge » 31 Jan 2014, 23:07

Doxygen (une bonne introduction à la pratique) : http://franckh.developpez.com/tutoriels/outils/doxygen/
phpDoc une page synthétique http://wiki.ovidentia.org/index.php/PHPDoc

Léo a recommandé d'utiliser la syntaxe Javadoc/phpdoc (compréhensible par l'outil Doxygen) "pour deux raisons : C'est celle que j'ai l'habitude d'utiliser et je suis suis sur qu'elle fonctionne avec mon IDE (Netbeans 7.3) pour l'autocompletion."

Côté choix de la langue :
Je préfère des commentaires plutôt que rien faute de maîtrise de l'anglais.
Google translate est assez performant (français -> anglais) et ne demande qu'à s'améliorer avec nos contributions ;)
Dans la mesure du possible je rédigerai dans les deux langues (anglais et français) les commentaires détaillés mais la fatigue aidant ça sera d'abord en français.
Avatar de l’utilisateur
Rui Serge
 
Messages: 63
Inscription: 04 Mai 2013, 08:57

Re: Documentation du code pour le développeur

Messagepar Rui Serge » 04 Fév 2014, 23:44

Hello

De vos échanges e-mail, on ne peut pas comparer la documentation technique du code d’une librairie (celle de Ola) et le wiki d’un langage (manuel du php).
Pour être correct il faudrait comparer la documentation du code C++ duquel on peut générer les exécutable de php avec la doc du code de Ola. Si ce n'est pas plus obscure, alors oui, ça pourrait être un bon exemple.

Il y a un peu plus de matière sur Ola en bas de la page suivante : http://www.opendmx.net/index.php/Open_L ... chitecture

A+ RS
Avatar de l’utilisateur
Rui Serge
 
Messages: 63
Inscription: 04 Mai 2013, 08:57

Re: Documentation du code pour le développeur

Messagepar Garanchon » 22 Mai 2017, 08:46

I am willing to be a part of volunteer work.
Garanchon
 
Messages: 2
Inscription: 22 Mai 2017, 08:05


Retourner vers Opensource coding

Qui est en ligne

Utilisateurs parcourant ce forum: Aucun utilisateur enregistré et 1 invité

cron