In quanto tempo documentare il Framework NET


E 'necessario documentare il .NET Framework C # o VB.NET codice sorgente?

Mentre si potrebbe farlo a mano, vale la pena di investire in uno strumento di documentazione di .NET utility chiamata. Questo piccolo pratico strumento Documenti rapidamente tutto il codice per voi, lasciando con meno tempo da spendere per operazioni ripetitive.

Il codice documentato .NET Documentation Tool crea automaticamente la documentazione del codice sorgente in diversi formati:

  • HTML è utile per l'introduzione di una fonte di riferimento per la documentazione della banca dati a portata di mano nella Intranet del vostro cliente o la vostra azienda. Il codice sorgente è completamente colorata con uno schema simile a quello utilizzato da Visual Studio colore.
  • Formato HTML Help è il file di formato standard di aiuto di Microsoft Windows e consente la documentazione applicazione .NET per essere contenuti in un unico file. Database di documentazione prodotta dalla Guida HTML Documentation Tool NET ha anche una buona entità codice indice quali classi e metodi, e completamente ricercabili!
  • Microsoft Word/RTF banca dati documentazione formato è ideale per la stampa e visualizzare i loro manager di linea!
  • La documentazione in formato testo può essere la base di ogni altra documentazione che può essere informata di scrivere per un'applicazione.

documentazione di .NET per le applicazioni .NET

Essere classe basata è utile per documentare le classi di un'applicazione, insieme con i metodi (funzioni e subroutine), geometri e proprietà all'interno di quella classe.

La caratteristica migliore di .NET Framework dal punto di vista della documentazione è la possibilità di all'XML commenti in C # o VB.NET codice sorgente. Questi commenti sono estratti dal strumento di documentazione di .NET e sono incluse nella documentazione del progetto NET.




Questo è un grande vantaggio di .NET, se il team di sviluppo si integra direttamente commenti nel codice, allora la domanda è quasi propria documentazione. Conservare la documentazione in conformità con il codice significa anche che il team di sviluppo può facilmente tenere documentazione aggiornata.

.NET Documentazione documento strumento qualsiasi progetto .NET da applicazioni GUI e librerie di classi indipendenti console di Windows.

Web Application Documentazione

ASP.NET

Documentare strumento .NET ha supporto aggiuntivo per ASP.NET. Supporto ASP.NET prevede il riconoscimento di pagine master (.master), controlli utente (ascx), controlli Web, web.config, JavaScript file di inclusione (JS), fogli di stile CSS (css), manipolatori web (. ASHX) di file e servizio Web (.asmx). Variabili Application e sessione individuati all'interno del codice.

Proprio come il .NET C # o VB.NET codice sorgente, documentazione di .NET può anche documentare i dati di SQL Server o Microsoft Access associati ad un'applicazione .NET. La documentazione può quindi visualizzare le tabelle, viste e stored procedure associati a un'applicazione. Per database di documentazione di SQL Server dedicato, uno strumento per la documentazione di SQL è inoltre disponibile.

Se avete ancora luoghi classici ASP, quindi uno strumento di documentazione per ASP Classic ASP è inoltre disponibile.

Quindi, se si vuole risparmiare tempo prezioso e quindi dare un strumento go .NET Documentation (versione di prova gratuita è disponibile per il download).

  • Strumenti finale documentazione utente per la creazione di un'ampia documentazione per l'utente - Info Barrel
    Strumenti per la scrittura di documentazione per l'utente finale superiore.
  • .NET Documentation Tool
    Documentor codice automatico per il Framework .NET
  • Software Documentazione Risorse Portal
    Risorse per il software di documentazione strumenti, utilities e servizi

(0)
(0)

Commenti - 0

Non ci sono commenti

Aggiungi un commento

smile smile smile smile smile smile smile smile
smile smile smile smile smile smile smile smile
smile smile smile smile smile smile smile smile
smile smile smile smile
Caratteri rimanenti: 3000
captcha