J'ai pris un fichier au pif de dotclear, les classes et fonction sont bien documentées. C'est suffisamment rare pour que cela soit relevé.
Cependant, la documentation est écrite en pseudo-HTML. Il y a des balise dans les commentaire qui permettent de décrire que l'on parle d'un paramètre, d'un type, d'une variable...Pour moi, c'est faire aussi du code.
Ce que dotclear a fait est un travail énorme en terme de code, mais aussi en terme de documentation du code.
J'ai pas de solution miracle, mais je pense qu'il y a des avancées à faire sur les système de documentation.
[^] # Re: FreeDFD ?
Posté par _seb_ . En réponse au journal PHPXref pour les scripts Shell. Évalué à 1.
Cependant, la documentation est écrite en pseudo-HTML. Il y a des balise dans les commentaire qui permettent de décrire que l'on parle d'un paramètre, d'un type, d'une variable...Pour moi, c'est faire aussi du code.
Ce que dotclear a fait est un travail énorme en terme de code, mais aussi en terme de documentation du code.
J'ai pas de solution miracle, mais je pense qu'il y a des avancées à faire sur les système de documentation.