VbCommenter

pubblicato il 31/10/2006

Abbiamo visto come con NDoc sia possibile generare file di help per le nostri classi, partendo da commenti opportunamente formattati nel nostro codice; utilizzando l'ambiente C# del Visual Studio 2003 è gia possibile creare il template di questi commenti semplicemente inserendo una riga vuota prima della dichiarazione di una namespace, classe, proprietà, evento o metodo, digitare (in questa riga vuota) tre slahsh (///) premere Invio e vedere inserito lo scheletro di commento che andrà poi integrato. Tutto ciò non è disponibile per i programmatori Vb, che si trovano di fronte a tre possibilità: infischiarsene allegramente e vivere felici lo stesso, farsi venire un attacco di bile e comprare un tool commerciale (scrivendosi a manina tutti i commenti), oppure ricorrere al mondo del software free e installare VbCommenter.

Una volta installato, è sufficiente posizionarsi sulla riga vuota immediatamente precedente a ciò cge vogliamo documentare:

Public Class DynamicTraceListener

 inserire tre apostrofi:

'''
Public Class DynamicTraceListener

premere il tasto [Enter] ed osservare la magia:

''' -----------------------------------------------------------------------------
''' Project : Framework.General.Application
''' Class : Framework.General.Application.MyClass
'''
''' -----------------------------------------------------------------------------
''' <summary>
'''
''' </summary>
''' <remarks>
''' </remarks>
''' <history>
''' [Marco Turrini] 31/01/2006 Created
''' </history>
''' -----------------------------------------------------------------------------
Public Class DynamicTraceListener

A questo punto non resta che integrare lo scheletro inserito con i nostri commenti; questi verranno inseriti, oltre che nel codice, anche in un file xml (con stesso nome dell'assembly ed estensione .xml), il quale sarà a sua volta processato da NDoc per la generazione vera e propria della documentazione.

Un ultima cosa: con la versione 2005 di Visual Studio, anche i programmatori Visual Basic si sono ritrovati questa funzionalità integrata nativamente nell'ambiente di sviluppo.