Passa ai contenuti principali

Code Contracts, generazione della documentazione e VB.NET

works-on-my-machine-starburst_3

Durante queste vacanze estive (vacanze???) mi sono messo a scrivere uno speciale per DomusDotNet che uscirà a breve e che riguarda i Code Contracts (http://research.microsoft.com/en-us/projects/contracts/).

I Code Contracts, come leggerete nello speciale su DomusDotNet (e non ve lo anticipo ora perchè, altrimenti che l’ho scritto a fare), permettono di rendere il nostro codice più robusto ed hanno il vantaggio che finiscono nella documentazione delle classi (con dei commenti XML generati automaticamente).

Tutto questo è molto bello se non che mi sono accorto che ciò che viene descritto nel manuale non funziona esattamente con VB.NET (sto lavorando con la versione 1.4.30707.2, del 7 Luglio 2010).

In particolare, abilitando la generazione dei dati per l’help (il file XML che si trova all’interno della cartella di compilazione), al termine della compilazione si dovrebbero trovare due file XML: uno quello classico (con estensione .old) e l’altro quello che contiene le informazioni dei Code Contracts.

Questo non accade con VB.NET. Il file è uno solo e non ha le info dei Code Contracts.

A questo punto mi sono venuti in aiuto (e li ringrazio) Francesco Logozzo e Mike Barnett due dei facenti parte del progetto Code Contracts di casa Microsoft.

Ho contattato Francesco via email spiegandogli il problema e, in breve tempo, hanno trovato l’inghippo e “fixato” il tutto (che uscirà nella prossima versione).

Il problema è dovuto al fatto che il componente che genera la documentazione utilizza, al suo internoi, il valore DocFileItem che è differente tra C# e VB (vedere http://social.msdn.microsoft.com/forums/en-us/msbuild/thread/5BA92371-E249-47DA-A411-18675C6AFBF5).

L’attuale versione del generatore di documentazione, fa il suo lavoro in VB ma non mette i file all’interno della cartella del compilato (ad esempio bin\debug) bensì lascia i due file nella cartella dei file temporanei della compilazione (ad esempio obj\x86\debug).

Sapendo questo, possiamo aggiungere (almeno fino a che non esce la nuova versione “fixata”) uno script di pot-build che semplicemente copia i file nella cartella bin\debug (ovviamente ragionando sulla configurazione corrente).

Per fare questo prepariamoci un file PostBuildDoc.bat molto semplice:

  1. if exist %1.xml xcopy /C /Y %1.xml %2
  2. if exist %1.xml.old xcopy /C /Y %1.xml.old %2

che mettiamo all’interno della cartella dove risiede la nostra soluzione. Lo script altro non fà che copiare il file (privo di estensione) indicato nel primo argomento nella cartella indicata dal secondo argomento.

A questo punto ci basta aggiungere lo script di post-build utilizzando l’apposito tasto nel tab Compile delle proprietà di progetto:
 image

La pressione del tasto “Build Events..” apre la maschera di inserimento degli script di pre e post build:

imageAll’interno del text box riservato al post-build event scriviamo:

  1. call "$(SolutionDir)PostBuildDoc.bat" "$(ProjectDir)obj\$(PlatformName)\$(ConfigurationName)\$(TargetName)" "$(ProjectDir)$(OutDir)"


Commenti

Post popolari in questo blog

VB.NET: Convertire un file DOC in RTF e PDF con office interop

In questo post vorrei proporvi del codice per poter convertire un file .doc in un file .rtf oppure .pdf utilizzando le API di interoperabilità di Office.Creeremo una classe, DocConverter, che esporrà le due funzionalità sopra citate.Cominciamo con il prevedere un attributo privato della classe che rappresenterà l’applicazione Word che utilizzeremo per la conversione. Creeremo l’istanza dell’attributo privato all’interno del costruttore della classe:PublicSubNew()
IfNot CreateWordApp() Then
ThrowNew ApplicationException("Assembly di interoperabilità con Office non trovato!")
EndIf
EndSub
Private _wordApp As Word.ApplicationClass
ProtectedFunction CreateWordApp() AsBoolean
Dim retval = True
Try
_wordApp = New Word.ApplicationClass()
_wordApp.Visible = False
Catch ex As System.Exception
_wordApp = Nothing
retval = False
EndTry
Return retval
EndFunction

La conversione del file doc sarà effettuata aprendo il file stesso ed eseguendo un’operazione di SaveAs:

Pr…

VB.NET for Dummies: Gli Eventi

Vorrei iniziare con questo post una serie dedicata ad aspetti di VB.NET di base che possono essere utile a coloro che si avvicinano al mondo .NET e che, in genere, non vengono trattati a livello base.La serie di post non ha la pretesa di essere assolutamente esaustivi sugli argomenti che tratteròIn questo primo post parleremo degli eventi.Cosa sono e a cosa servonoUn evento è la “notifica” dell’accadimento di qualcosa.Quando, ad esempio, premiamo un bottone della finestra di un’applicazione, dietro le quinte, il bottone stesso “notifica” al mondo circostante che qualcuno, in quell’istante, lo ha premuto.Sta, poi, al mondo circostante preoccuparsi di “intercettare” l’evento stesso per gestirlo (tramite un gestore di evento).Attenzione a non confondere la pressione del tasto con la “notifica” della pressione del tasto: l’evento è la “notifica” dell’accadimento, non l’accadimento stesso.Ma a cosa serve tutto ciò?Utilizzare gli eventi è un modo per disaccoppiare due o più attori del nostr…

Creare uno shortcut con VB.NET

Prendendo spunto da un post comparso sul forum MSDN vorrei proporvi un tip su come creare uno shortcut utilizzando VB.NET.Per poter creare uno shortcut possiamo procedere in due modi: o ci studiamo la struttura del file .lnk e scriviamo una classe che è in grado di ricreare tale struttura oppure utilizziamo Windows Scripting Host.La prima soluzione è percorribile ma laboriosa perchè la struttura di un file lnk non è banale. Chi fosse interessato a vedere come è composto, internamente, un file lnk può scaricare la seguente reference guide (link).Io vorrei proporvi la seconda strada e realizzerò una classe che incapsula l’utilizzo di Windows Scripting Host.L’object model di Windows Scripting Host è contenuto nella dll IWshRuntimeLibrary che può essere referenziata, nel nostro progetto, utilizzando il tab COM della finestra di aggiunta delle reference:Tra gli oggetti che troviamo all’interno della libreria utilizzeremo la classe WshShell e la classe WshShortcut.La prima delle due rappres…