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


Etichette:

Commenti

Posta un commento

Post popolari in questo blog

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 servono Un 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 ...
Posta un commento
Continua a leggere

VB.NET: SplashScreen con effetto fade-in

In questo post vorrei proporvi un modo per realizzare una splash screen per le nostre applicazioni Windows Form che appare progressivamente con un effetto fade. Supponiamo di avere il nostro progetto VB.NET in una soluzione Visual Studio 2008 in cui abbiamo il sorgente della nostra applicazione Windows Form. Inseriamo una splash screen utilizzando il menù Progetto->Aggiungi Nuovo Elemento e selezionando il tipo di elemento “Schermata Iniziale” A questo punto Visual Studio creerà, automaticamente, la schermata iniziale che possiamo personalizzare graficamente come vogliamo. Per poter fare in modo che questa finestra appaia nel momento in cui avviamo l’applicazione, è necessario aprire le proprietà del progetto e impostare la maschera di avvio: In questo modo, all’avvio dell’applicazione, la schermata appare immediatamente e scompare un attimo prima della visualizzazione della finestra dell’applicazione. Possiamo far apparire la schermata iniziale con un ef...
Posta un commento
Continua a leggere

Alla scoperta del Kinect: presentazioni e convenevoli

Oggi è arrivato un Kinect nuovo nuovo su cui cominciare a fare sperimentazione ed ho, quindi, deciso di condividere tutto ciò che scopro, le cavolate che faccio e i segreti che scopro con chi mi segue. I post che cercherò di scrivere con frequenza sono post di un neofita che si avvicina all’”Aggeggio” e che quindi sono diretti a chi nulla dell’argomento. Gli esperti troveranno noiosi e banali questi post, ma non si può aver tutto dalla vita. Per cominciare, scartato l’”Aggeggio” ho cominciato a preparare l’ambiente di sviluppo: 1) Visual Studio 2010 Ultimate (che uso normalmente ma che non è necessario in quanto si può sviluppare tranquillamente con la express edition); 2) Kinect SDK, scaricabile all’indirizzo http://research.microsoft.com/en-us/um/redmond/projects/kinectsdk/download.aspx 3) DirectX Software Development Kit scaricabile all’indirizzo http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=6812 A questo punto vi basta connettere il Kinect al...
Posta un commento
Continua a leggere