CODEWITHSUNDEEP
c#xml
Mukesh Kumar
Mukesh Kumar

Reputation: 2376

How to Create C# Documentation Using SandCastle

I am using Sand Castle with Visual Studio 2010 to create documentation for my C# code. I am able to create documentation using xml comments with C# code. But It shows all in documentation like classes, methods, interfaces etc. But I don't want to generate private classes documentation. I tried to find out but I didn't find.

So, Any-one can help me to achieve this. Thanks in advance.

Upvotes: 0

Views: 712

Answers (1)

Deepak Bhatia
Deepak Bhatia

Reputation: 6276

For everything to work you have to add the documentation help to be associated with each of the class, method, properties etc. For adding XML documentation to any of them just type /// at the previous line of every function, class etc it will generate all the tags and then you can fill the information about them.

For example,

///
public Class1()

and you will see XML help section generated automatically in Visual Studio as,

 /// <summary>
 ///              //You can add description here....
 /// </summary>
 public Class1()
 {

After generating these tags you can follow the instructions posted at Documentation Generation

Upvotes: 2

Related Questions