Daryl Zuniga and Mike Barnett - Xml Documentation from Code Contracts for .Net

Posted By: Peli de Halleux | Aug 10th @ 3:55 PM | 58,690 Views | 12 Comments
Mike Barnett and Daryl Zuniga, a high school intern at RiSE, sit down to talk about Code Contracts for .NET and documentation. Daryl has been working this summer on a tool that inserts contracts elements into the Xml Documentation files generated by the C#/VB compiler. Daryl also updated the Sandcastle stylesheets so that the contracts appear in the documentation pages.

 Update: the xml comment generation is now available for download!

The Research in Software Engineering team (RiSE) coordinates Microsoft's research in Software Engineering in Redmond, USA.
Rating:
1
0
#Sep 3rd @ 10:24 AM
mbarnett
mbarnett

Yes, the idea is that the bubbles (adornments) should show up when you are writing an override of a virtual method in a supertype or an implementation of an interface method and you are going to inherit a contract from the overidden method or the interface method (respectively). Otherwise you might not be aware of it.

#Nov 4th @ 7:08 AM
dylandog
dylandog

Hi guys,

 

I must say that you have done a great job with code contracts.

 

But unfortunately, I am having some problems with this Xml Documentation from Code Contracts. I have taken the same steps as Daryl on this video, but I am not able to get the contract tags into the xml documentation file. I am using 1.2.21023.14 version and tried it with both VS2008 and VS2010 Beta 2. There are no errors but simply contracts are not shown.

 

How should I resolve this issue?

Microsoft Communities