Resumé

Sandcastle per Creare Documentazione .Net

Cristian Merighi () 0,00

C'è un nuovo progetto di Microsoft, nome in codice Sandcastle, il cui scopo è quello di creare documentazione per librerie .Net agendo via reflection...
Questo articolo è da considerarsi obsoleto. Alcune funzionalità potrebbero non essere più disponibili e non è possibile aggiungere commenti.

Ho recentemente avuto la necessità di creare files/schermate di documentazione relativamente alle mie librerie C# 2.0 (prima volta).
Affidandomi a Google sono venuto a conoscenza del progetto NDoc, che però sembra essere stato definitivamente abbandonato né mai più aggiornato, dopo l'uscita (novembre 2005) della versione 2.0 del Framework.
Proprio perché sono fortunato, pare che la stessa Microsoft (e proprio in questo periodo - estate 2007) stia distribuendo quello stesso tool da lei utilizzato per produrre la documentazione che vediamo ogni giorno sul sito MSDN (ad esempio).

Il nome in codice di questo progetto è Sandcastle.

Al momento è TOTALMENTE PRIVO di interfaccia grafica!... si tratta di null'altro se non un insieme di tools da utilizzare via riga di comando, ognuno dei quali ha un compito specifico nella filiera che porta dai commenti "///" del nostro codice al rendering della documentazione.
Come link utile (eccome) per l'utilizzo di questi tools vi indirizzo qui.

Nel pacchetto scaricabile da qui (June 2007 CTP) si possono trovare anche tutte le ICONE, files XSL, fogli di stile CSS, scripts JS utilizzati per Visual Studio 2005 (persino i files XML dei vari assembly del .NET Framework 2.0!)).

Ho testato il tutto per le mie API Pacem.Drawing e devo ammettere che è piuttosto utile e comodo, sono altresì a conoscenza del fatto che stanno intercorrendo cambiamenti negli standard di rendering xml (comunque personalizzabile tramite appositi xsl) percui rimango in curiosa attesa di future, e più strutturate, releases!

Take care. Bye.

feedback
 

Syndicate

Autore

Cristian Merighi facebook twitter google+ youtube

Ultimi articoli

Top rated

Archivio

Dove sono?

Autore

Cristian Merighi facebook twitter google+ youtube

Le mie letture

Feeds