This project has moved. For the latest updates, please go here.

How to document Typed DataSet's

Topics: Developer Forum, User Forum
Mar 19, 2007 at 3:51 PM

Thx for a wonderful tool - love it.

How do I document typed datasets.... ?

Jens Chr
Mar 19, 2007 at 6:45 PM
Sorry, I don't use them so I can't say for sure. If they are part of your project then they should end up in the compiled assembly and the XML comments files so it should just work.

Mar 19, 2007 at 9:12 PM
Thx - the special problem with documenting typed datasets is that the code i auto generated based on a xsd file, so it's hopeless to add /// comments inside the generated code - it will disappear next time the xsd file is changed. So I guess the question is if it is possible to prepare a kind of 'shadow xml' file that contains comments for the dataset, without actually embedding the comment in the .cs codefile...

Great tool - with or without dataset documentation !

Jens Chr
Mar 19, 2007 at 10:28 PM
You can add a "Comments Only" XML file to the project to contain comments for such items. See the "Sharing Summary and Namespace Settings Between Projects" for details on how to create the file. The process is similar.

Mar 22, 2007 at 9:55 AM
Great, will try that - Thx
Jens Chr