Documentazione del codice sorgenteAttualmente utilizzo NaturalDocs per generare automaticamente la documentazione basata su HTML del codice JSL che scrivo.Funziona abbastanza bene con un semplice markup di commento all'interno del codice:
Attualmente sto configurando un nuovo ambiente di sviluppo ed è un'opportunità per rivedere gli strumenti all'interno del mio flusso di lavoro.Mi chiedevo solo se qualcuno avesse altri pensieri sugli strumenti di generazione della documentazione per JSL?
Ri: Documentazione del codice sorgenteHo appena installato su un nuovo PC - in allegato è una descrizione del processo
Ri: Documentazione del codice sorgente@uday_guntupalli Vado avanti e lo installo su un nuovo computer.Sono felice di documentare e condividere la procedura una volta completata (ho dovuto estendere la configurazione per gestire il linguaggio JSL).
Ri: Documentazione del codice sorgente@David_Burnham ,
Ho provato a prendere spunto e installare Natural Docs. Dopo averlo impostato nel modo descritto qui ( http://www.naturaldocs.org/getting_started/getting_set_up/#starting_a_new_project ), quando provo a eseguire configure per generare la documentazione, ottengo quanto segue
Tuttavia, come indicato, ho fornito la cartella di input e la cartella di output - Qualche idea su cosa ho fatto di sbagliato?
Ri: Documentazione del codice sorgenteNaturalDocs sembra molto interessante.Grazie per avercelo fatto conoscere!
Piccola diramazione di questa discussione: ecco alcune utilità open source che trovo indispensabili per lo sviluppo di programmi:
TartarugaSVN : H aiuta i programmatori a gestire diverse versioni del codice sorgente per i loro programmi (sistema di controllo del codice sorgente).Client Apache™ Subversion (SVN)®, implementato come estensione della shell di Windows.
Blocco note++: Blocco note di Windows sotto steroidi.Colorazione della sintassi per la maggior parte delle lingue.
Kdiff3: Programma diff basato su Windows.Ottimo per trovare e unire le differenze tra due o tre file o directory.
Ri: Documentazione del codice sorgenteHo iniziato questo percorso con DOxygen (uso uno spin off, roxygen2, ampiamente in R) ma non sono andato abbastanza lontano per distribuire qualcosa con JSL. NaturalDocs sembra una buona scelta.
