Édition : CodeGenerationDocumentation

Génération de documentation selon le code-source

Connu pour ma part depuis NDoc, je cherche cette solution fort pratique pour mes projets dans tous les langages.

Liens

• Liste de liens Doxygen

---

.Net

• NDoc (plus compatible au dela du framework 2.0)
• NDoc 2.0 Alpha (reprise du projet NDoc)

---

VB ou le VBScript

VBDox

Très rapide à mettre en oeuvre, ce logiciel open-source en VB fournit une bonne base.
La sntaxe Java est la plus pratique et les pages Todo, Bugs et History permettent un très pratique plan d'action du code.

• Utiliser le style Java >>

• Script de test :

 ''
 ' <h1>Test de VBDox</h1>
 ' Test complet de VBDox
 ' 
 ' @remarks  Premier test en live
 ' @author   fabio
 ' @version  0.0.1
 ' @date     2006-06-08
 ' @history  2006-06-08 : 1ere version
 ' @bug      Plante si pas de texte
 ' @todo     Compléter les commentaires
 ' @todo     Compléter la documentation
 ' @require  test_functions.vbs
 ' @include  test_functions.vbs
 
 '' Titre général
 Dim gTitre  
 Dim sConfiguration
 
 '' Chemin de l'éxécutable
 Dim sPathExe
 
 ' Attribution du titre
 gTitre = "Test VBDox"
 
 ' @todo     Compléter les commentaires
 wscript.echo WriteDate("Fabio")
 
 
 ''
 ' Affiche le texte et la date du jour
 ' @param    sText   Texte à afficher
 ' @return 	        Le text harodaté
 ' @remarks  <i>A améliorer</i>
 ' @todo     Ne rien renvoyer si pas de texte
 ' @version  0.5.1
 ' @history  2006-06-08 : 1ere version
 ' @see      #getdate
 Function WriteDate(sText)
   WriteDate = GetDate() & " - " & sText
 End Function
 
 ''
 ' Retourne la date
 ' @param    Aucun
 ' @return   La date du jour
 ' @version  0.1
 ' @see    #WriteDate
 ' @todo     Préciser le format de la date
 Function GetDate()
   GetDate = Now()
 End Function

---

PHP

• PHPDocumentor >> Site officiel
• Tutoriel officiel >>
• Tutoriel en français >> Survol et prise en main rapide de PHPDocumentor.

---

Python

Pour documenter les scripts python de BankPerfect par exemple...

• Doxygen