SandCastle and VB.Net Applications

Hello

I've read the blogs indicating that SandCastle will in fact generate help content using the /doc:assembly.xml switch. I'm sorry but I don't understand this statement. Can someone please elaborate (that is a step by step procedure) to generate help content. Case in point; Do I enter coments as '/// in the source code; etc.

Thanks in advance.

BigGuy

[385 byte] By [BigGuy] at [2008-1-10]
# 1

Hey BigGuy,

Yes you author /// comments in your source code. Please see http://msdn2.microsoft.com/en-us/library/ms172652.aspx and http://msdn.microsoft.com/msdnmag/issues/02/06/xmlc/ to get started. After doing this then you can doenload "Sandcastle" to convert these source code comments into CHM/HxS/Html/XML formats. Eric has a great GUI for Sandcastle at http://codeplex.com/Wiki/View.aspx?ProjectName=SHFB

Releated resource:

Anand..

AnandRaman-MSFT at 2007-10-3 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...
# 2

Thanks Anand.

This is exactly what I was looking for.

Regards

BigGuy

BigGuy at 2007-10-3 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...
# 3

Anand:

What about comments in VB.net?

Thank you,

PN

pniang at 2007-10-3 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...
# 4

Use triple single quotes instead of triple slashes:

Code Snippet

''' <summary>

''' A test summary

''' </summary>

Public Sub Test()

End Sub

The tags are the same.

Eric

EWoodruff at 2007-10-3 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...
# 5
You can also download the my XML Documentation Comments guide from:
http://www.dynicity.com/Products/XMLDocComments.aspx
This will give you information on all of the tags that are available, what tags are applicable to various code elements, and links to other resources.
Later,
Eric
Dynicity at 2007-10-3 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...

Visual Studio

Site Classified