Code documentation
A key application of contracts is to provide a standard way to document software.
Are there plans for new tags relatives to contracts in XML comments or something else ?
Answers
- See http://channel9.msdn.com/posts/Peli/Xml-Documentation-from-Code-Contracts-for-Net/
Jonathan "Peli" de Halleux- Marked As Answer byMike BarnettMSFT, OwnerWednesday, August 12, 2009 4:28 PM
- The latest releases now support documentation generation and adding contracts to XML docs. Check out the documentation.
Cheers, -MaF (Manuel Fahndrich)- Marked As Answer byManuel FahndrichMSFT, OwnerWednesday, November 04, 2009 4:04 PM
All Replies
- We are definitely investigating this. We are working with the Sandcastle team to figure out the best way to surface the contracts into the documentation. I guess the fact that our tools for this are lagging behind the runtime checking and static checking just reflects that sad truth that documentation always comes last...
- Marked As Answer byMike BarnettMSFT, OwnerMonday, March 09, 2009 2:01 PM
- Unmarked As Answer byMike BarnettMSFT, OwnerWednesday, August 12, 2009 4:28 PM
- Proposed As Answer byMike BarnettMSFT, OwnerFriday, March 06, 2009 7:37 PM
- See http://channel9.msdn.com/posts/Peli/Xml-Documentation-from-Code-Contracts-for-Net/
Jonathan "Peli" de Halleux- Marked As Answer byMike BarnettMSFT, OwnerWednesday, August 12, 2009 4:28 PM
- The latest releases now support documentation generation and adding contracts to XML docs. Check out the documentation.
Cheers, -MaF (Manuel Fahndrich)- Marked As Answer byManuel FahndrichMSFT, OwnerWednesday, November 04, 2009 4:04 PM
