/// Style comments and documentation

  • Thread starter Thread starter A.M-SG
  • Start date Start date
A

A.M-SG

Hi,



I have all my code commented with /// type of comments. What are my options
to generate MSDN like documentation for my code and also possibly create a
help file for my code?



Thank you,

Alan



/// <summary>
///
/// </summary>
/// <param name="procName"></param>
/// <returns></returns>
protected string GetPackageProcName(string procName)
{
 
You can try NDoc, an open source document generator @ ndoc.sourceforge.net.

There are other 3rd party tools as well that do the same thing.

Hi,



I have all my code commented with /// type of comments. What are my options
to generate MSDN like documentation for my code and also possibly create a
help file for my code?



Thank you,

Alan



/// <summary>
///
/// </summary>
/// <param name="procName"></param>
/// <returns></returns>
protected string GetPackageProcName(string procName)
{
 
Hi Alan,

Is your problem resolved? Yes, the NDoc tool will automatically generate
documentation for your code using reflection to examine the assembly and
using the XML generated from your C# XML comments. It should meet your
need. If you have any concern, please feel free to tell me, thanks

Best regards,
Jeffrey Tan
Microsoft Online Partner Support
Get Secure! - www.microsoft.com/security
This posting is provided "as is" with no warranties and confers no rights.
 
Back
Top