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

MVP Reconnect …… ovvero quando entri nella “famigghia” resti sempre nella “famigghia”!!!

Ma di che “famigghia” stiamo parlando!!!!

Fermi tutti, non si tratta di robe strane o sette segrete o affari malavitosi….stiamo parlando della grande famiglia dei Microsoft MVP.

Per chi non sapesse cosa sono i Microsoft MVP, vi consiglio di fare un giro sul sito ufficiale del programma (link), ma, volendolo spiegare in pochisime parole, si tratta di un riconoscimento che Microsoft da a persone che si distinguono per il loro impegno, aiutando gli altri ad ottenere il massimo grazie alle tecnologie Microsoft. Si tratta di persone, non dipendenti Microsoft, che mettono la loro passione, il loro tempo, la loro buona volontà per la divulgazione e la condivisione della conoscenza. Non necessariamente (come qualcuno erroneamente sostiene, evidentemente non conoscendo le basi del programma) si tratta di professionisti nel termine letterale del termine ma si tratta comunque di un gruppo di persone che sacrifica un pò del suo tempo (e, a volte, vi assicuro neanche pò!!!) per la sua passione.

Pe…

Template di progetto per sviluppare applicazioni WPF con Intel® RealSense™

E’ disponibile, nella gallery di Visual Studio, la prima versione del mio template di progetto per applicazioni WPF scritte in C# che permette di realizzare applicazioni con l’SDK di Intel® RealSense™.Il template si può scaricare direttamente all’interno Visual Studio utilizzando il tool “Extensions and Updates”oppure all’indirizzo https://visualstudiogallery.msdn.microsoft.com/1c36ecfd-8c00-4aee-b20c-a1726ab6424dIl template esegue le seguenti operazioni per voi:Aggiunge la reference all’assembly libpxcclr.cs.dll (nelle due distinte versioni per x86 e x64);Aggiunge lo script di post build per copiare la libreria libpxccpp2c.dll dalla cartella dell’SDK alla cartella bin del vostro progetto.Una volta creato il progetto dovete rimuovere la configurazione di compilazione AnyCPU (che non ha più senso) dalla vostra solution e sarete pronti per sviluppare con Intel® RealSense™.Ovviamente dovete installare l’SDK che potete scaricare all’indirizzo https://software.intel.com/en-us/intel-realsen…

Nuova versione del Band SDK

E’ di ieri l’annuncio del rilascio della nuova versione dell’SDK per il Microsoft Band.
Si tratta della versione 1.3.10417 (la precedente e, prima della serie, era la 1.3.10219 preview).
Maggiori informazioni, download dell’SDK per le tre piattaforme Windows Phone, iOS e Android all’indirizzo http://developer.microsoftband.com/.
Allo stesso indirizzo potrete trovare anche la documentazione.
Nei mesi scorsi mi sono gia’ occupato della precedente versione e questi sono i post che ne parlano:
Microsoft Band SDK Preview - First LookMicrosoft Band SDK Preview - ”Hello Band”Microsoft Band SDK Preview - Accesso ai sensoriMicrosoft Band SDK Preview - TileMicrosoft Band SDK Preview - NotificheMicrosoft Band SDK Preview - Personalizzazione
Gli argomenti trattati e il codice proposto dovrebbe, ad una prima lettura delle nuove funzionalita’ inserite, essere ancora valido e funzionante ma nei prossimi giorni prendero’ in esame tutti gli argomenti dei precedenti post e vedremo cosa cambia e cosa e’ …