help file

  • Thread starter Thread starter CJ Taylor
  • Start date Start date
C

CJ Taylor

Hey anyone have a good help file utility? Or recommend a good one? I'm
just too lazy right now and want to write out some help documenation for
this framework.


Thanks,
CJ
 
CJ Taylor said:
Hey anyone have a good help file utility? Or recommend a good one? I'm
just too lazy right now and want to write out some help documenation for
this framework.
Click to expand...

You can use XML comments which can be used for creating an online help
(using NDOC, for example):

My XML Comments FAQ:

VB Commenter
<http://www.gotdotnet.com/team/ide/>
-> section "VB Commenter"

XML Documentation
<http://www.gotdotnet.com/team/vb/>
-> section "XML Documentation"

VBXC - VB.NET XML Commentor
<http://vbxmldoc.tor-erik.net/index.shtml>

NDOC (formerly DOC.NET)
<http://ndoc.sourceforge.net/>

VB.DOC
<http://vb-doc.sourceforge.net/>
 
Herfried,

Thanks, I already have the stuff for the VB stuff, and for the code. But
remember this framework is intended to go to an "end user" as well. Someone
not so proficient in the art of code.

So, I want to build another pretty help system that kinda explains to a
developer how the framework works. So your not just looking at a bunch of
classes and saying "Where do I start", but when you get stuck, there it is
to bail you out..

AND THEN

combine that with technogarb from the class files for reference.

Thanks
CJ
 
CJ,
I have seen Microsoft is busy building a Visual.Studio.Net help system.
I have loaded it, but I did not see any documentation at all.
(One little HTML file, but that cost to much time to figure out, the help on
help is very poverty)
Maybe this is a tremendous good topic for the chat session on 30 September?
Cor
 
Back
Top