Documenti naturali Documenti naturali - Generatore di documentazione multi-lingua open source, extensible, multi-lingua
Scarica ora

Documenti naturali Classifica e riepilogo

Documenti naturali Tag

creare Generatore Genera documentazione generatore di documentazione Generazione della documentazione documetazione

Documenti naturali Descrizione

Documenti naturali - Generatore di documentazione multilingua open source, extensible, multi-lingua Documenti naturali è un generatore di documentazione multi-lingua open source, estensibile e multi-lingua. Devi solo documentare il tuo codice in una sintassi naturale che legge come semplice inglese. Documenti naturali eseguiranno quindi la scansione del tuo codice e creerà una documentazione HTML di alta qualità da esso. Ciò sono alcune caratteristiche chiave di "Documenti naturali": documentazione sorgente Sintassi naturale, leggibile: · La sintassi dei documenti naturali è progettata per essere molto naturale, quasi trasparente. I commenti nel codice sorgente leggono facilmente come la documentazione generata. Non ci sono praticamente tag disseminati. Lingue multiple: · Documenti naturali supportano il diciannove linguaggio di programmazione fuori dalla scatola, anche all'interno dello stesso progetto. Supporta i file CGI e senza estensione perché può determinare la loro lingua con le loro linee Shebang. Aggiungi la tua lingua: · Se il tuo linguaggio di programmazione non è già incluso con Documenti naturali, puoi aggiungere supporto per esso solo modificando un file di configurazione. Anche il linguaggio più oscuro può avere un potente generatore di documentazione. Tutte o semplicemente documentazione esplicita: · A seconda del livello di supporto linguistico, è possibile scegliere tra Documenti naturali Documentare tutto o solo ciò che hai documentato, il che lo rende adatto per generare riferimenti API. Parole chiave flessibili: · Documenti naturali hanno molte parole chiave per ciascuno dei suoi tipi di argomenti in modo da poter utilizzare il più naturale per te. Puoi anche personalizzare quelli esistenti o aggiungere il tuo. Argomenti e indici personalizzati: · Se desideri documentare un po 'di sfaccettatura del tuo codice che i documenti naturali non conoscono - forse è qualcosa di particolare per la tua lingua o il progetto - puoi creare il tuo tipo di argomento e parole chiave per questo. Documenti naturali lo costruiranno persino è il proprio indice. Elenchi: · Documenti naturali offrono una sintassi abbreviata per documentare grandi gruppi di piccoli oggetti, come costanti. Ognuno diventa un simbolo collegabile come se avesse il proprio argomento. Documentazione generata esathattractive: · A differenza della documentazione più generata, l'output dei documenti naturali sembra professionale per impostazione predefinita. Ci sono stili diversi tra cui scegliere, oppure puoi crearne uno stesso. Potente struttura CSS: · Documenti naturali hanno una struttura CSS potente e ben documentata che consente la piena personalizzazione. Sebbene gli stili predefiniti non lo facciano sempre, puoi fare cose come i collegamenti alle funzioni essere uno stile e collegamenti alle classi a essere un'altra. Puoi anche avere stili specifici del browser in un singolo file CSS per funzionare attorno a rendering stranni. Indirizzi e-mail trasparenti: · Gli indirizzi e-mail che appaiono nell'aspetto della documentazione e si comportano come collegamenti e-mail regolari, ma sono trasparenti universalmente per evitare crawler spam. Tooltip ovunque: · Ogni collegamento ad ogni argomento documentato ha il suo riepilogo come un suggerimento. I collegamenti a funzioni e variabili hanno anche i loro protoype completamente formattati nei tooltips. HTML incorniciato o senza cornice: · È la tua documentazione quindi è la tua scelta. È possibile mantenere ogni pagina essere indipendente e facilmente collegabile, oppure è possibile mantenere il menu in un telaio separato per una navigazione più facile. Ignora i prefissi nell'indice: · I prefissi comuni non devono rovinare i tuoi indici. Se tutte le tue classi iniziano con c, o se hai un sacco di funzioni che iniziano con com_, puoi avere documenti naturali ignorali così ccat, cdog e cmouse appaiono in c, d, e m invece di tutti i programmi C. Altamente automatizzato: · Documenti naturali rilevano quali parti del tuo albero di origine cambiano e regoleranno la documentazione di conseguenza. Manterrà automaticamente e organizzerà il menu se non lo fai da solo. Ricostruirà automaticamente la documentazione se le modificheranno la riga di comando oi modifiche al file di configurazione. Processo di costruzione differenziale: · Documenti naturali costruisce solo i file che sono stati modificati o aggiunti dall'ultima corsa e dai file che dipendono da loro, riducendo drasticamente il tempo di esecuzione e rendendolo adatto a progetti più grandi. Architettura estensibile: · Documenti naturali è progettato per essere facilmente esteso per diversi linguaggi di programmazione, argomenti e stili CSS, tutti documentati su questo sito. File di configurazione intelligenti: · Documenti naturali rileva le modifiche apportate ai file di configurazione e gestiranno i dettagli più piccoli. Riforma automaticamente in modo da poter effettuare modifiche rapide e sporche e mantenere la leggibilità. I file di configurazione del progetto mantengono un elenco aggiornato delle cose definite nei file principali in modo da sapere cosa puoi ignorare senza consultarli. Portatile: · Documenti naturali corre ovunque corre perl, e sono un sacco di posti. Gratuito e aperto: · Documenti naturali è concesso in licenza sotto il GPL, quindi non c'è alcun costo e puoi giocarci con la fonte alla gioia del tuo cuore.

Documenti naturali Software correlato