Articoli

Come documentare le applicazioni Angular, NestJS e Stencil: Compodoc

Documentare è fondamentale. Ne abbiamo parlato in tantissimi articoli e non finiamo mai di raccontare che la documentazione aiuta le aziende a crescere professionalmente, a condividere il “know how”, a creare relazioni proficue nel team di sviluppo ed ad applicare il miglioramento continuo nella qualità del software sviluppato.

Contattaci subito e senza impegno per creare la documentazione del tuo software.

Compodoc: la soluzione open source per documentare il codice sorgente

Compodoc è un tool sviluppato in Node.js nato per documentare applicazioni Angular che si è evoluto nel tempo per supportare anche la documentazione di applicazioni NestJS e Stencil.

Compodoc genera la documentazione statica partendo dal codice sorgente e permette di far comprendere con immediatezza le funzionalità della tua applicazione o dei tuoi script.

Disponibile in maniera open source al seguente link, Compodoc è uno strumento completo che ti fa navigare tra le funzionalità fornendoti informazioni dettagliate sui parametri, sulle azioni previste e sugli import. Per farti un’idea più concreta e toccare con mano la potenza di Compodoc ti invitiamo a visitare la demo basata su Angular, dove sulla colonna di sinistra potrai visualizzare gli elementi dell’applicazione come moduli, componenti, direttive, classi, injectables, interceptors, interfacce, pipes e routes, mentre sulla parte destra la descrizione di ogni elemento anche associata a grafici semplici e lineari al fine di utilizzare anche la grafica per la documentazione.

Contattaci subito e senza impegno per creare la documentazione del tuo software.

Le funzionalità di Compodoc

Oltre al supporto ad Angular, NestJS e Stencil, al fatto di essere open source ed ad avere un design semplice, Compodoc ti fornisce le seguenti funzionalità:

possibilità di utilizzare ben 8 temi differenti al fine di personalizzarne l’aspetto e renderlo aderente a scenari organizzativi interni come design policy e capacità tecniche ( per es. nei temi è integrato anche il Material Design);
supporto a tutti i linguaggi internazionali come Tedesco, Inglese, Spagnolo, Italiano, Giappone, Cinese, Polacco, ecc.. con l’i18n;
integrazione di un potente motore di ricerca interno per trovare facilmente le informazioni che ti servono;
funzionamento in locale ed offline senza necessità di alcun server;
parsing automatico di tutto il codice;
supporto di parametri di JSDoc come @param, @returns, @link, @ignore e @example.

In poche parole, Compodoc genera la documentazione della tua applicazione in maniera professionale, precisa ed affidabile.

Contattaci subito e senza impegno per creare la documentazione del tuo software.