50251_fr-FR

liliconcom

Documentation du code source

J'utilise actuellement NaturalDocs pour générer automatiquement une documentation HTML du code JSL que j'écris.Je fonctionne assez bien avec un simple balisage de commentaires dans le code :

 

Je suis actuellement en train de mettre en place un nouvel environnement de développement et c'est l'occasion de revoir les outils de mon workflow.Je me demandais simplement si quelqu'un avait d'autres idées sur les outils de génération de documentation pour JSL ?

 

Re : Documentation du code source

Je viens d'installer sur un nouveau PC - vous trouverez ci-joint une description du processus

Re : Documentation du code source

@uday_guntupalli Je vais de l'avant et je l'installe sur un nouvel ordinateur.Je suis heureux de documenter et de partager la procédure une fois qu'elle est terminée (j'ai dû étendre la configuration pour gérer le langage JSL).

Re : Documentation du code source

@David_Burnham ,
J'ai essayé de m'en inspirer et d'installer Natural Docs. Après l'avoir configuré de la manière détaillée ici ( http://www.naturaldocs.org/getting_started/getting_set_up/#starting_a_new_project ), lorsque j'essaie d'exécuter configure pour générer de la documentation, j'obtiens le message suivant

Cependant, comme indiqué, j'ai fourni le dossier d'entrée et le dossier de sortie. Avez-vous une idée de ce que j'ai mal fait ?

 

 

Re : Documentation du code source

NaturalDocs a l'air très intéressant.Merci de nous en avoir fait part !

 

Légère branche à cette discussion : voici quelques utilitaires open source que je trouve indispensables au développement de programmes :

TortueSVN :H Les programmeurs elps gèrent différentes versions du code source de leurs programmes (système de contrôle du code source).Client Apache™ Subversion (SVN)®, implémenté en tant qu'extension du shell Windows.

Bloc-notes++ : Le Bloc-notes Windows sous stéroïdes.Colorisation de la syntaxe pour la plupart des langues.

Kdiff3 : Programme de comparaison basé sur Windows.Idéal pour rechercher et fusionner les différences entre deux ou trois fichiers ou répertoires.

 

 

Re : Documentation du code source

J'ai commencé dans cette voie avec Doxygen (j'utilise un spin-off, roxygen2, largement dans R) mais je ne suis pas allé assez loin pour déployer quoi que ce soit avec JSL. NaturalDocs semble être un bon choix.