domenica 22 agosto 2010

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)"


Nessun commento: