Stack Overflow
Stack Overflow

Questions tagged [xml-documentation]

XML documentation is the way to generate automatic documentation from comments inside the code, to an XML formatted file that can be shown with any method, for e.g. a web page.

XML documentation are comments that form the documentation for C# programs. They are so called because they contain nested XML fragments. See Microsoft's XML Documentation Comments (C# Programming Guide) for more details.

391 questions
10
votes
1 answer

DocFX: Generate API documentation for multiple projects

I'm working on a project that has multiple projects in a solution. I would like to be able to generate the documentation from an outside directory to keep the application code folders clean. When I try to set the src directory in my docfx.json, it…
Terry Palmer
  • 103
  • 1
  • 5
10
votes
1 answer

Including Generated XML Documentation in an Azure Cloud Service Package

EDIT: Updated to specify that the issue only occurs when packaging an Azure cloud service CSPKG file. I have an ASP.NET Web API 2 application that acts as a web role in an Azure cloud service solution. I'd like to use the Web API Help Pages and…
RMD
  • 3,421
  • 7
  • 39
  • 85
10
votes
2 answers

How/under which circumstances does the tag in Delphi xml comments actually work?

I wonder how these XML references work, I'm just not getting why they work or why they don't work and I found nothing about that. Here's an example: type TOuterClass= class strict private type TLogger = class public ///…
RSE
  • 322
  • 1
  • 10
10
votes
5 answers

Difference between // and /// in c#

When I type ///, Visual Studio shows me some parameters like this: /// /// /// /// /// What is the difference between // and /// in C#?
mohammad
  • 1,248
  • 3
  • 15
  • 27
10
votes
1 answer

How do I reference members of other types in the XML docs for a method?

I have the following XML doc segment on one of my methods: /// /// Calculates the total charge for hours between the and of all all the records …
ProfK
  • 49,207
  • 121
  • 399
  • 775
9
votes
5 answers

Can I generate .MD files from XML Documentation?

I have used Sandcastle to document my class libraries recently. However, I have recently discovered that Sandcastle is no longer developed by Microsoft: https://archive.codeplex.com/?p=sandcastle. I have had a look online on GitHub and I see that…
w0051977
  • 15,099
  • 32
  • 152
  • 329
9
votes
4 answers

How to generate C# documentation to a CHM or HTML file?

Is there a way to generate a readable document file from the documentation on the code directly from Visual Studio? (also considering 2010) Code example: /// /// Convert a number to string /// /// An integer…
BrunoLM
  • 97,872
  • 84
  • 296
  • 452
9
votes
1 answer

Web Api Help Page - Show only some controllers but no others

I've an application made in Web Api 2.1 (Visual Studio 2012 C#) and I made a Help page with XML Documentation. I just want only expose some controllers, not all controllers of my Web Api, but at the same time I don't want to remove the comments…
Leandro Bardelli
  • 10,561
  • 15
  • 79
  • 116
9
votes
2 answers

NuGet Package not copying XMLDoc file along with dll to bin

I'm using NuGet GUI and trying to include XML File along with my DLL to distribute help along with the DLL. When I install package in any of the project, it adds the DLL reference successfully, but XML file is not generated inside bin folder of the…
Amit Andharia
  • 909
  • 1
  • 8
  • 16
8
votes
4 answers

Build Sandcastle Documentation When Building Visual Studio Project

I am using the Sandcastle Help File Builder to output my C# XML-DOC file to the Website format. How can I accomplish the samething from the command line so that I can add this as a build event in Visual Studio when building the actual project? The…
John Chapman
  • 878
  • 3
  • 14
  • 28
8
votes
1 answer

Visual Studio Intellisense for cref's in Xml Documentation

When you create XML Documentation for C# methods in Visual Studio (I'm using 2010), you receive Intellisense support for creating the various XML tags, such as see, paramref, etc. On the other hand, when you add in a a cref attribute you have to use…
wwahammy
  • 467
  • 1
  • 5
  • 14
8
votes
3 answers

DescriptionAttribute vs. tag for Properties

I'm writing a Class Library in C# under VS 2005 (I know, get with modern times, but we're on a tight budget here). It appears to me that if I use a "summary" tag in the XML documentation, my users can see that info via Intellisense and tooltips,…
John66NY
  • 121
  • 1
  • 6
8
votes
1 answer

IDE Plugin for XMLDoc

there is an IDE Plugin out there (I think it was not free) which assists in writing XMLDocumention inside the IDE. I tried to search for it, but I cannot find it anymore. Anybody knows it?
Steffen Binas
  • 1,463
  • 20
  • 30
8
votes
2 answers

XML Documentation for dependency properties

What is the best way to document a dependency property? Should I put the xml documentation on the field: /// Documentation goes here public static readonly DependencyProperty NameProperty = …
Stefan
  • 4,187
  • 1
  • 32
  • 38
8
votes
1 answer

How to view the content of the tag?

In Microsoft Visual C# 2010 Express, whenever I create a function, and use the 3 slashes to create the help code, I get something like this: /// /// Function to sum 2 numbers. /// /// First number. ///…
user2323401
  • 123
  • 1
  • 3
1 2 3
…
26 27