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
6
votes
0 answers

How to remove extra summary tag in Visual Studio XML comments for XAML files?

I'm seeing two summary tags in the generated XML documentation for WPF files. One comes from the code behind file as expected. The other appears to be auto-generated by the compiler as it seems to come from the .g.cs file. Any idea how to remove the…
Harley Pebley
  • 103
  • 5
6
votes
2 answers

How to force a Documentation element to reference the type instead of the property with the same name?

It is relatively common practice for property names to default to the type name when the type name is significant enough; public class User { } public class UserSession { /// /// Creates a instance …
Jean Hominal
  • 16,518
  • 5
  • 56
  • 90
6
votes
1 answer

Intellisense not showing XMLDOC for referenced DLL

I'm using VS-2010 Ultimate version 10.0.30319.1 RTMRel (from the about box). I have written a class library with lots of nice XMLDOC (imho). For reasons I don't want to get into when I use this library in various solutions the project itself is not…
The Dag
  • 1,811
  • 16
  • 22
6
votes
2 answers

Where to put the XML documentation comments for an attached property?

Assuming I have an attached property defined like that : public static string GetMyProperty(DependencyObject obj) { return (string)obj.GetValue(MyPropertyProperty); } public static void SetMyProperty(DependencyObject obj,…
Thomas Levesque
  • 286,951
  • 70
  • 623
  • 758
6
votes
1 answer

Add different default and custom tags to Visual Studio XML Documentation

I am just learning how to use the XML documentation capabilities in visual studio and C#. The default XML tags used in the documentation are "summary", "param name", and "returns". I'd like to add "remarks" to the default tags. I'd also like to add…
user1352442
  • 61
  • 4
5
votes
1 answer

Skip XML documentation files with Web Deploy

I'm trying to publish a .NET web service using Web Deploy. Currently it's including XML documentation files in the package. I've unchecked "XML documentation file" in the Build tab of the project properties in Visual Studio. This stops that XML file…
TrueWill
  • 25,132
  • 10
  • 101
  • 150
5
votes
1 answer

What's the syntax to inherit documentation from another indexer?

In my implementation I have this: /// public T this[long row, long column] { ... } The XMLdoc is already present in the IInterface. How can I pick it up from there (like I do for other things)? I get a…
Matthew Strawbridge
  • 19,940
  • 10
  • 72
  • 93
5
votes
4 answers

Generics in XML documentation issue

I am trying to include a code snippet in my class XML documentation but the compiler complaining that an xml element is not closed! Here is what I am trying to achieve /// /// Method documentation here... /// /// ///…
GETah
  • 20,922
  • 7
  • 61
  • 103
5
votes
2 answers

JetBrains Rider - is there an easy way to generate the XML documentation file?

VS has a checkbox that just builds the XML documentation file from C#. I couldn't find anything like this in JetBrains Rider's build settings. What's the easiest way to do this?
user1026169
  • 5,345
  • 5
  • 21
  • 35
5
votes
1 answer

Can DocumentationFile and GenerateDocumentationFile be used together in .Net project file?

I'm writing a small analyzer for C# projects that checks if the XML documentation generation is present and set up correctly. There are two options for to specify XML documentation: An older DocumentationFile option A newer…
SENya
  • 1,083
  • 11
  • 26
5
votes
3 answers

VS Intellisense: Show INDENTED multiline code example on hover-over

Is such a thing possible? If it's not clear what I'm talking about, here's a detailed example: Take this quick utility class I wrote a few weeks ago (details omitted), along with the example I want to share: public abstract class…
khancast
  • 85
  • 6
5
votes
1 answer

How to tag code in C# XML documentation

I have this function: public static string Join(this IEnumerable strings, string separator) { return string.Join(separator, strings.ToArray()); } which I want to document. I want the tag to say string.Join(separator,…
sbi
  • 219,715
  • 46
  • 258
  • 445
5
votes
2 answers

XML documentation of Action parameters in C#

I am looking for a way to document action parameters in C#. Code looks like this: /// /// Do some action with parameters. /// /// This is action but what about parameters? public void…
Optional Option
  • 1,521
  • 13
  • 33
5
votes
1 answer

How to put a line break in xmldoc comments

I have a following summary snippet. /// /// Holds the future state for 4 pixels /// Every pixel can be in 4 states, on, off, unknown, or don't care /// Off=00, on=01, unknown = 10, don't care = 11. /// The grid is like…
Johan
  • 74,508
  • 24
  • 191
  • 319
5
votes
1 answer

Documenting external dll's with sandcastle

I'm currently developing an application, which requires external dll's which I do not control. I'd like to add documentation for these classes, so that others can understand why I'm making certain calls I'm making to these external DLL files. Adding…
Blue
  • 22,608
  • 7
  • 62
  • 92
1 2 3
…
26 27