TDocumentation dotNet
Versione: 1.0.0.0
Descrizione: Questo programma permette di generare una documentazione dettagliata di ogni file sorgente scritto in vb.net. Per funzionare, implementa un parser di codice che legge i tag xml del codice e li associa ai membri corrispondenti. Fra le opzioni, si possono nascondere i membri privati o quelli privi di commenti, e c'è la possibilità di scegliere se generare un singolo file di documentazione per ogni sorgente o se unire tutto in un un'unica pagina. Il formato di output del programma è HTML, tuttavia la sua struttura ad incapsulamento permette di definire delle nuove classi generatrici di codice in differenti formati.
Il programma produce una pagina web in testa alla quale vi è uno schema della struttura delle classi documentate: ogni membro e ogni oggetto è corredato del suo nome e della sua categoria (classe, struttura, funzione, variabile, eccetera...) e cliccandovi sopra si può saltare direttamente alla parte in cui viene descritto in dettaglio. Dopo l'intestazione, iniziano i veri e propri dati: ogni entità contenitore (classi, strutture, interfacce, moduli, spazi di nomi, enumeratori) viene rappresentata da un box grigio al cui interno sono listati ordinatamente i membri, ognuno seguito da uno o più di questi campi informativi:
- Signature (azzurro) : riporta la riga di codice che dichiara il membro
- Descrizione (verdino) : riporta la descrizione dell'oggetto, definita nel tag "summary"
- Parametri (verde) : riporta la lista dei parametri del metodo e la loro descrizione (tag "param")
- Dettagli (fuchsia) : riporta i dettagli (tag "remarks")
- Vedi anche (giallo) : riporta eventuali collegamenti logici con altre entità nel codice (tag "see"/"seealso")
- Valore restituito (viola) : riporta i dettagli sui possibili valori restituiti dalla funzione/proprietà (tag "returns")
- Parametri generics (arancio) : riporta la lista dei parametri generics e la loro descrizione (tag "typeparam")
- Eccezioni (grigio) : riporta una lista e la relativa descrizione delle eccezioni che potrebbe generare il codice commentato (tag "exception")
Download: Eseguibile / Sorgenti
The Totem's Lair - Copyright (C) 2009
È vietata la riproduzione sia totale che parziale del sito.



