Comments on XML codes in .NET.

Question

How much do you use XML comments in your code files and how to use them? I saw that you can use them to create XML documentation, but can this XML documentation be used to create an HTML help file or a schema file for your code?

Also, have any commenting tools been used to create auto-generators (i.e. GhostDoc) and what are your impressions?

Thoughts?

Answer 1

XML , XML DLL. , API , IDE ( Intellisense ).

, , XML - XML . Microsoft Sandcastle - . HTML 1 (, CHM) HTML Help 2 ( , Visual Studio). (: NDoc, , , , Sandcastle, , , , .) , - SandcastleDocs ( Microsoft, ). , Builder Builder Sandcastle - .

Answer 2

, , . , Intellisense.

Answer 3

, , api. , apis, , .

1: SandCastle , , , , . , chm, - .

, . .

2: NDoc , , 1.1.NET.

3: XSLT - CodeProject xslt

http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx

, . xslt , XML . XML , XML- -.

.

Answer 4

! , , , . , . , . , .

SandCastle , HTML CHM - ! SlickEdit, , !

Answer 5

, API xml . , intellisense, Reflector.

.., ISV.

Answer 6

SandCastle Microsoft MSDN Xml . , .net framework, Xml.

http://msdn.microsoft.com/en-us/vstudio/bb608422.aspx

Answer 7

XML. , . intellisense.

GhostDoc - , , GhostDoc , . , GhostDoc ; - . , .

Sandcastle ( ). , Builder Builder - , Sandcastle.

Answer 8

I am trying to use NuDoc to create static API sites in markdown format. The API is clean, modern and very easy and easy to use (if I could say so myself;)): http://kzu.to/nudoc

It is also open source, so patches and improvements are always welcome.