Solved

Generate help documents from XML VS 2005

Posted on 2008-06-18
21
208 Views
Last Modified: 2013-11-26
Hi!

I like to generate a help documnet from the XML code that I have in my code.

Like the VBCommenter
http://msdn.microsoft.com/en-us/library/aa289191(VS.71).aspx
0
Comment
Question by:AWestEng
  • 11
  • 9
21 Comments
 
LVL 53

Assisted Solution

by:Dhaest
Dhaest earned 500 total points
ID: 21811509
What exactly do you want to do ?

Integrate XML code comments into Visual Studio 2005/2008 using Sandcastle and HTML Help 2.0
http://saftsack.fs.uni-bayreuth.de/~dun3/archives/integrate-xml-code-comments-into-visual-studio-20052008-using-sandcastle-and-html-help-20/150.html
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21811665
generate help documents fron the XML comments that I have for each sub/function etc
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21811679
If I try to downlaod I'll get this

This project is not yet published

If you are a coordinator or developer on this project, please sign in to access the project.
0
 
LVL 53

Accepted Solution

by:
Dhaest earned 500 total points
ID: 21811803
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21811907
Ok.. So I have installed the sandcatle

I'm trying to understand this part.

Build > Help File Format: Enable HtmlHelp2x
Build > Dependencies: Add all assemblies your assembly depends on here.
Build > Framework Version: Select the .NET Framework version your assembly is build on.
Help File > Presentation Style: Select vs2005. This is not neccessary but pretty.
Paths > HtmlHelp2xCompilerPath: Give the path to the directory where hxcomp.exe is located.
Paths > SandcastpePath: Set it to the correct installed sandcastle path. In my case I had multiple versions
of sandcastle installed and had to specify where the newest version is installed.


but I can't find these settings?
0
 
LVL 53

Expert Comment

by:Dhaest
ID: 21811937
Probably is the version changed ...
I'll check it !

Perhaps this link can help you
https://blogs.msdn.com/sandcastle/archive/2006/07/29/682398.aspx
0
 
LVL 25

Expert Comment

by:apeter
ID: 21812264
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21812265
hmm. I new to this so I'm not sure how to do it in VS 2005

I  don't understand the text in the url

sorry for all the questions..

0
 
LVL 1

Author Comment

by:AWestEng
ID: 21812269
that one is only for vs 2003
0
 
LVL 53

Assisted Solution

by:Dhaest
Dhaest earned 500 total points
ID: 21812298
Perhaps this can help you. This works with nDoc.

HOWTO: Generate XML Source Code Comments for Visual Studio 2005 ASP.NET Visual Basic Website App_Code assembly
http://www.carljohansen.co.uk/codelib/copyappcodexml/
0
Do You Know the 4 Main Threat Actor Types?

Do you know the main threat actor types? Most attackers fall into one of four categories, each with their own favored tactics, techniques, and procedures.

 
LVL 1

Author Comment

by:AWestEng
ID: 21812322
oki. so this is not the sandcastle , this is something else?
0
 
LVL 53

Expert Comment

by:Dhaest
ID: 21812356
Actually it's almost the way I do it. I let my visual studio generate an xml-document and with ndoc I create a chm, xml, ... depending of my needs. Usually I use it to document my project
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21812412
oki.
When I installed the SDK for Vs 2005 I got HelpStudio from http://www.innovasys.com/

Is this something you know about?
0
 
LVL 53

Expert Comment

by:Dhaest
ID: 21812456
I don't know, so I can't tell anything about it.
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21812510
okit thx anyway..

If I chech the nDoc url I can see theis code snippet

<system.codedom>
<compilers>
<compiler language="vb;vbs;visualbasic;_vbscript" extension=".vb" type="Microsoft.VisualBasic.VBCodeProvider, System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" compilerOptions="/doc+ /optionstrict+"/>
</compilers>
</system.codedom>

But that is for ASP how shuld it look in VB
0
 
LVL 53

Expert Comment

by:Dhaest
ID: 21812557
Now DONOT try to run the NDoc Application by clicking F5. I did that initially and I had a solution that had around 5-6 projects. It was failing giving an error: Falied to load Assembly&blah..blah..

So the solution is to run the NDocGui.exe from NDoc2005\src\Gui\bin\Debug path.

Now before starting the generation, you need to enable the XML document generation for each project in VS 2005(Project Properties->Build->Output->XMlDocumentationFile)

Now add the decoration for you class and methods.
I found some good article on this at:
http://www.codeproject.com/csharp/csharpcommentinganddocs.asp
which could be a good starting point.

Now run the NDocGui.exe and specify ur solution name. It took a good amount of time to convert, but it is really fantastic.

You get the MSDN style documentation, very neat and clean.

Thanks a lot to NDoc..!!
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21812667
Oki..

I have donloaded the ndoc .
When I run nDoc there is a GUI that is opend.
What do I do now?

Can i implement the nDoc in VS like a add-in or something or must I always run the nDoc as a separately project ad create the help doc from that?
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21812727
and when trying to import the solution into the nDoc I got this

"There are no projects in this solution that NDoc can import.

Either the solution is blank, or the projects contained within
the solution are not of a type NDoc can import."
0
 
LVL 53

Expert Comment

by:Dhaest
ID: 21812807
>> Can i implement the nDoc in VS like a add-in or something or must I always run the nDoc as a separately project ad create the help doc from that?

It's always a separate project.
Now run the NDocGui.exe and specify ur solution name (through the add-button).
Next is to generate the help (fifth icon or ctrl-shift-B)
It took a good amount of time to convert, but it is really fantastic.
0
 
LVL 1

Author Comment

by:AWestEng
ID: 21813116
oki I got it to work now. thx alot.. :)
0
 
LVL 53

Expert Comment

by:Dhaest
ID: 21813127
Glad I could help you.
0

Featured Post

Do You Know the 4 Main Threat Actor Types?

Do you know the main threat actor types? Most attackers fall into one of four categories, each with their own favored tactics, techniques, and procedures.

Join & Write a Comment

Suggested Solutions

Parsing a CSV file is a task that we are confronted with regularly, and although there are a vast number of means to do this, as a newbie, the field can be confusing and the tools can seem complex. A simple solution to parsing a customized CSV fi…
The ECB site provides FX rates for major currencies since its inception in 1999 in the form of an XML feed. The files have the following format (reducted for brevity) (CODE) There are three files available HERE (http://www.ecb.europa.eu/stats/exch…
The viewer will learn how to use NetBeans IDE 8.0 for Windows to connect to a MySQL database. Open Services Panel: Create a new connection using New Connection Wizard: Create a test database called eetutorial: Create a new test tabel called ee…
The viewer will learn how to synchronize PHP projects with a remote server in NetBeans IDE 8.0 for Windows.

744 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

16 Experts available now in Live!

Get 1:1 Help Now