Esiste un programma che può aiutare a capire un altro programma?

Question

Ho bisogno di documentare il software al momento sto lavorando. Il software è costituito da diversi linguaggi di programmazione e script che mi hanno fatto riflettere. Se un nuovo sviluppatore arriva e ha bisogno di aggiustare qualcosa, potrebbe conoscere Java ma forse non bash scripting. Sarebbe bello se ci fosse un programma che aiuterebbe a capire cosa

for f in "$@" ; do 

mezzi. Stavo pensando a qualcosa che crea una pagina HTML statico con il codice più evidenziazione della sintassi e se si passa sopra qualcosa (come il "per"), sarebbe visualizzare un pop-up con una spiegazione:

for inizia un ciclo che itera su tutti i valori che seguono in. Nel ciclo, è possibile accedere a ciascun valore tramite la variabile $f. Il corpo del ciclo è compresa tra do e done

Ha qualcosa del genere già esiste?

[EDIT] Questo è solo un esempio. Otterrai un altro aiuto per f, in, "$@", ; e do, vale a dire ogni singolo elemento della linea dovrebbe essere spiegato. Gli elementi sconosciuti (come i nomi dei comandi) devono essere collegati a Google. Quindi puoi capire cosa fa anche se ti manca qualche dettaglio.

[EDIT2] Sono consapevole che non è possibile scrivere un programma che capisca cosa fa un altro programma. Quello che sto cercando è un semplice strumento che farà "l'evidenziazione estesa della sintassi" nel senso che colorerà un'espressione e darà una spiegazione breve cosa significa (più forse un collegamento ad alcuni riferimenti approfonditi).

Questo è pensato per qualcuno che sa come programmare ma forse non ha mai visto qualche costrutto oscuro prima. Dire

echo "Error" 1>&2 

Ogni programmatore bash sa che cosa questo significa, ma uno sviluppatore Java potrebbe essere perplesso dalla 1>&2 nonostante il fatto che essi possono intuire che echo == System.out.println. Un semplice "Reindirizzamento da stdout a stderr" cancellerà le cose e darà quell'istante "AHA!" che consente loro di rimanere nel loro attuale pensiero.

Answer 1

Se ci pensi, non è molto utile avere uno strumento che spieghi la sintassi. Gli sviluppatori potevano semplicemente google per parole chiave invece di navigare in un sito web in modo simile a http://www.codeweblog.com/source/.

Credo che i buoni commenti saranno di gran lunga più utili, in più ci sono strumenti per estrarre la documentazione usando i commenti (ad esempio, HappyDoc lo fa per Python).

Answer 2

È una cosa molto complessa. Prima di tutto, per definizione, si può dimostrare che il programma che "comprenderà" qualsiasi programma non esiste. Tuttavia, è ancora possibile utilizzare la documentazione esistente. Forse usare strumenti come Doxygen può aiutarti. Dovresti documentare il tuo codice attraverso i commenti e la documentazione verrà generata da loro.

Answer 3

IMO sarebbe più semplice e più efficace raccogliere semplicemente i collegamenti a riferimenti e tutorial specifici della lingua in una pagina Wiki.

Per tutte le lingue tradizionali, tali sorgenti esistono e vengono mantenute regolarmente.Se si tenta di creare il proprio riferimento, è necessario mantenerlo anch'esso. Giusto, la sintassi di bash non cambierà molto spesso, ma altri linguaggi si sviluppano più velocemente, quindi sarà un peso.

Answer 4

Un linguaggio non può essere spiegato solo attraverso la sua sintassi. L'ambiente runtime svolge un ruolo importante, insieme alla filosofia di base del linguaggio e delle libraie.

Inoltre, la sintassi non è così complessa per i linguaggi più comuni (dato che il codice è stato scritto tenendo presente la manutenibilità).

Proseguendo con l'esempio bash, non si può comprendere a fondo bash se si sa nulla sui processi & controllo dei job, le variabili di ambiente, una grande lista di comandi Unix (TR, ordinare, tagliare, incollare, sed, awk, trovare,. ..) e molte altre funzionalità che non appaiono in sintassi.

Answer 5

Uno strumento come questo può essere creato utilizzando ANTLR, ovvero analizza il codice in un albero di sintassi astratto utilizzando una grammatica ANTLR per quel linguaggio e scrive un generatore HTML che ha prodotto il codice annotato.

Sembra uno strumento utile da utilizzare per l'apprendimento delle lingue o per esplorare il codice sorgente di progetti che non vengono gestiti, ma è appropriato per la documentazione?

Perché è importante aiutare i programmatori di altre lingue a comprendere il codice a questo livello di dettaglio di implementazione? Chiunque mantenga l'implementazione a questo livello dovrà ovviamente conoscere la lingua e probabilmente avrà un IDE per fare la maggior parte di questo.

Detto questo, considererei senz'altro uno strumento come questo un aiuto per l'apprendimento.

Answer 6

Se lo strumento ha prodotto

per inizia un ciclo che itera su tutti i valori che seguono in. Nel ciclo , è possibile accedere ad ogni valore attraverso la variabile $ f. Il corpo del loop è tra il do e il fatto

sarebbe abbastanza inutile. Questo è esattamente il tipo di commento che i programmatori (umani) tirocinanti sono stati detti a scrivere.