Doxygen for Mac - Download

Quindi sei uno sviluppatore, giusto? Hai questa solida base di codice, ma nessuno la leggerà mai a meno che tu non scriva la documentazione. E che Dio ti aiuti se devi farlo a mano. È qui che entra in gioco Doxygen. L'ho usato su alcuni progetti paralleli, principalmente su Python e C++ e, onestamente, mi ha fatto risparmiare ore. Esegue semplicemente la scansione del codice, estrae i commenti e crea pagine HTML pulite con elenchi di funzioni, gerarchie di classi e persino grafici delle chiamate. Nessuna magia, ma funziona.

La roba buona

Ciò che mi ha davvero colpito è stata la velocità con cui ha trasformato i miei commenti disordinati in qualcosa di realmente utilizzabile. Ad esempio, avevo un file di intestazione con 15 funzioni, tutte documentate con /// O /** */. Esegui Doxygen, boom: sito HTML navigabile istantaneamente. Non è necessario copiare e incollare in una wiki o mantenere un file di markdown separato. Anche l'output sembra decente: non appariscente, ma funzionale. Se lavori in gruppo, è molto più semplice che provare a spiegare cosa fa ciascuna funzione tramite messaggi Slack. Inoltre, supporta più lingue, quindi non è solo per C++ come alcuni strumenti che ho visto.

Il non-così-buono

Sì, è gratuito, il che è fantastico, ma la curva di apprendimento non è zero. All'inizio il file di configurazione (Doxyfile) può essere travolgente. Devi modificare i percorsi, scegliere i formati di output, impostare la visibilità dei simboli... mi ci sono voluti due tentativi prima che l'output PDF funzionasse. E non c'è alcuna GUI. Solo riga di comando. Quindi, se sei una persona che odia i terminali, questo potrebbe sembrare goffo. Inoltre, i documenti generati sono accurati solo se i tuoi commenti lo sono. Se salti la documentazione di una funzione, Doxygen non indovinerà cosa fa. E lo strumento non si integra molto bene con gli IDE: devi eseguirlo manualmente o crearne uno script. Non terribile, ma nemmeno liscio.

In conclusione

Se stai scrivendo codice che verrà utilizzato da altre persone, che si tratti di un progetto personale o di un repository di gruppo, vale la pena scaricare Doxygen per Mac - Download per Windows. È gratuito, funziona e riduce la domanda "cosa fa questa funzione?" caos. Non è lo strumento più appariscente in circolazione, ma svolge il lavoro senza problemi. Saltalo solo se stai scrivendo script usa e getta o odi gli strumenti CLI. Altrimenti, provaci. Ti ringrazierai più tardi.