Se ci sono gli sviluppatori che amano documentare il proprio codice, non li ho incontrati. Ma se siete uno sviluppatore che documenta il vostro codice, Documento Innovasys! X ridurre sostanzialmente i costi, fornire un quadro per la documentazione e verificare che la documentazione viene fornito in un formato familiare: Guida di Visual Studio.
Dopo l'installazione di documento! X, troverete una nuova barra di menu in Visual Studio che include un documento aperto! X pulsante (disattivato in ASP.NET progetti di siti Web). La prima volta che si fa clic sul, documento pulsante! X fornisce un elenco di DLL che genererà sostegno documento nel progetto. Documento! X fa scelte intelligenti nella scelta di quali DLL saranno documentati di default - non selezionare le DLL di sistema o di Visual Basic spazio dei nomi My, per esempio. Qualsiasi momento successivo, si utilizza il pulsante all'interno del progetto, si apre il documento! X IDE con il progetto di documentazione per la soluzione caricato.
Per impostazione predefinita, una pagina di avvio rapido viene visualizzato quando Documento X! comincia a lasciare aver configurato il vostro progetto di documentazione. È possibile, ad esempio, aggiungere componenti aggiuntivi al progetto di documentazione. Documento! X genera la struttura per i database che documenta, schemi XSD e componenti COM. Sarà anche prendere una pugnalata alle librerie JavaScript (anche se non l'JavaScript nel tuo. Pagine aspx).
Tutti i componenti documentazione generata per la vostra applicazione sono tenuti, per impostazione predefinita, in una cartella denominata "Documentazione" nella struttura delle cartelle del progetto dell'applicazione. Documento X! fornisce anche l'integrazione con Subversion e l'altra fonte di controllo gli strumenti per consentire di tenere traccia e condividere tali componenti.
 |
| Figura 1. Generazione di documentazione sviluppatore: Dopo aver specificato le DLL che si desidera documento, documento! X genera le pagine della Guida per le classi contenute - ma è ancora la vostra responsabilità di scrivere il contenuto. |
Processo automatizzato
C'è una ricchezza di funzioni nel documento! X. Un elenco di attività, ad esempio, fornisce una forma rudimentale di project management per il progetto di documentazione. Pur riguardando. NET sviluppatore, documento! X analizzerà anche i componenti COM si aggiunge al progetto di documentazione e fornire i documenti scheletro per loro. Diversi modelli personalizzabili per la generazione di documentazione vengono forniti, incluso il supporto per Visual Studio 2008 e il 2010 stili. Una riga di comando per costruire l'output documentazione è incluso in modo che si può generare la documentazione come parte di un processo automatizzato.
Sorprendentemente, il Documento! X aiutano sistema mi ha deluso. Mentre ero impressionato dalla qualità complessiva, non riuscivo a capire come generare i diagrammi modello di relazione d'oggetto.
Alcuni componenti aggiuntivi possono essere necessari per generare la documentazione. Prima di poter avere un documento! X progetto di generare un file di Guida di Windows, è necessario scaricare e installare il compilatore della Guida di Microsoft (che è gratuito). All'interno del vostro documento! Progetto X è possibile attivare funzioni comunitarie per creare pagine che gli utenti finali possono aggiornare selezionando una sola opzione. Per fare quel lavoro, tuttavia, si sia bisogno di aggiungere estensioni Comunità Innovasys al server Web o acquistare un abbonamento al servizio Innovasys hosting.
Ci sono diverse ipotesi qui - che ti documentare il codice e che lo farai al livello forniti da Microsoft per i componenti di Microsoft NET Framework.. Se si sta sviluppando il software da utilizzare all'interno della propria organizzazione (o solo da te stesso), si può sentire che non è necessario che il livello di documentazione.
Corso Visual Studio - Corsi Visual Studio
Corso .Net- Corso Dot.Net - Corso Vb.net
Corso C# - Corso PHP - Corso Joomla
Nessun commento:
Posta un commento