Help on Help

  • Thread starter Thread starter Guest
  • Start date Start date
G

Guest

I'm wrting a new control for which I would like to write Help Documenting for
all the classes, properties, memebers etc in a professional way. What do I
need to do. I'm using VB .NET 2.0 where I've created XML tags to all of my
classes.
 
Thanks for the reply. What I meant was my need to create a real Help file
associated with my control. I need to know how to create such file. I assume
that having XML tags in my source code can help in the process (but I could
be wrong).
 
Hi Avi,
Thanks for the reply. What I meant was my need to create
a real Help file associated with my control. I need to know
how to create such file...
Click to expand...

It appears you need the utility NDoc, which generates class library
documentation from .NET assemblies and the XML documentation files
generated by the C# compiler (or with an add-on tool VBCommenter PowerToy
for VB.NET).

NDoc could generate documentation in MSDN-style HTML Help format (.chm) or
the Visual Studio .NET Help format (HTML Help 2), and MSDN-online style web
pages, but currently its latest version only support .NET
Framework1.1(VS2003). A new version, 2.0 is still in the alpha testing
stage, I suggest you can refer to the following website and forum
discussion thread for the details:

Generate documentation under .Net 2.0?
http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=171880&SiteID=1

NDoc Code Documentation Generator for .NET
http://ndoc.sourceforge.net/

VBCommenter PowerToy
http://www.gotdotnet.com/workspaces/workspace.aspx?id=112b5449-f702-46e2-87f
a-86bdf39a17dd


By the way, I also found an automatic generator of technical documentation
for Visual Basic .NET(including VB.NET 2005) , but it is not a free
software:

VBdocman .NET
http://www.vbdocman.com/net/


Thanks!

Best regards,

Gary Chang
Microsoft Community Support
--------------------
Get Secure! ¡§C www.microsoft.com/security
Register to Access MSDN Managed Newsgroups!
http://support.microsoft.com/default.aspx?scid=/servicedesks/msdn/nospam.asp
&SD=msdn

This posting is provided "AS IS" with no warranties, and confers no rights.
 
Thanks.
--
Avi
American Society of Composers Authors and Publishers
New York, NY



"Gary Chang[MSFT]" said:
Hi Avi,
Thanks for the reply. What I meant was my need to create
a real Help file associated with my control. I need to know
how to create such file...
Click to expand...

It appears you need the utility NDoc, which generates class library
documentation from .NET assemblies and the XML documentation files
generated by the C# compiler (or with an add-on tool VBCommenter PowerToy
for VB.NET).

NDoc could generate documentation in MSDN-style HTML Help format (.chm) or
the Visual Studio .NET Help format (HTML Help 2), and MSDN-online style web
pages, but currently its latest version only support .NET
Framework1.1(VS2003). A new version, 2.0 is still in the alpha testing
stage, I suggest you can refer to the following website and forum
discussion thread for the details:

Generate documentation under .Net 2.0?
http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=171880&SiteID=1

NDoc Code Documentation Generator for .NET
http://ndoc.sourceforge.net/

VBCommenter PowerToy
http://www.gotdotnet.com/workspaces/workspace.aspx?id=112b5449-f702-46e2-87f
a-86bdf39a17dd


By the way, I also found an automatic generator of technical documentation
for Visual Basic .NET(including VB.NET 2005) , but it is not a free
software:

VBdocman .NET
http://www.vbdocman.com/net/


Thanks!

Best regards,

Gary Chang
Microsoft Community Support
--------------------
Get Secure! ¡§C www.microsoft.com/security
Register to Access MSDN Managed Newsgroups!
http://support.microsoft.com/default.aspx?scid=/servicedesks/msdn/nospam.asp
&SD=msdn

This posting is provided "AS IS" with no warranties, and confers no rights.
Click to expand...
 
Back
Top