C# Code Comments
-
I'm sure many of you have experimented with the code commenting features in C#. For those of you who haven't it works like this - above a function you can place some code comments using a special identifier "///" in xml format, like this: /// /// Logs the user into the system /// /// User's name /// User's password /// Boolean value indicating success (true) or failure (false) /// User name or password was incorrect The C# compiler provides you with the option to generate an xml file containing all of these comments in a nicely structured format. VS.NET provides a utility to generate web pages from this xml file. These web pages are rather nice, and could be bundled into a .chm file for distribution. However, this tool doesn't generate pages of the same quality as msdn. The pages look pretty yukky and only certain info is included - for example exceptions are not shown, which is a problem as consumers need to know what exceptions might be thrown. So after that whole essay - does anybody know of a tool which can generate nice documentation (up to the standard of msdn), and then package that documentation automatically into .chm files? If not, would this be a valuable article? If so, would somebody be willing to collaborate with me on this effort? Cheers
-
I'm sure many of you have experimented with the code commenting features in C#. For those of you who haven't it works like this - above a function you can place some code comments using a special identifier "///" in xml format, like this: /// /// Logs the user into the system /// /// User's name /// User's password /// Boolean value indicating success (true) or failure (false) /// User name or password was incorrect The C# compiler provides you with the option to generate an xml file containing all of these comments in a nicely structured format. VS.NET provides a utility to generate web pages from this xml file. These web pages are rather nice, and could be bundled into a .chm file for distribution. However, this tool doesn't generate pages of the same quality as msdn. The pages look pretty yukky and only certain info is included - for example exceptions are not shown, which is a problem as consumers need to know what exceptions might be thrown. So after that whole essay - does anybody know of a tool which can generate nice documentation (up to the standard of msdn), and then package that documentation automatically into .chm files? If not, would this be a valuable article? If so, would somebody be willing to collaborate with me on this effort? Cheers
Take a look at nDoc, it has an option to produce output almost exactly like MSDN :) James Simplicity Rules!
-
Take a look at nDoc, it has an option to produce output almost exactly like MSDN :) James Simplicity Rules!
James! You don't know how much easier you have made my life; nDoc is EXACTLY (a good start anyway) what I was looking for... Thanks, Neil A. Van Note
-
James! You don't know how much easier you have made my life; nDoc is EXACTLY (a good start anyway) what I was looking for... Thanks, Neil A. Van Note
>>nDoc is EXACTLY (a good start anyway) what I was looking for... I concur, thank you James! :) Is a society built on greed better than a society built on survival?