Stack Overflow
Stack Overflow

Questions tagged [xml-comments]

Can refer to 1) comments in XML documents or 2) XML markup used for documentation in programming language comments.

A comment in an XML document looks like this:

<!-- comment text -->

See https://www.w3.org/TR/xml/#sec-comments.

For information on the second meaning of this tag, see https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/.

See also https://blog.submain.com/using-xml-comments/.

315 questions
4
votes
2 answers

Tools for editing XML code comments more productively?

I am on the look for tools that help with editing and managing good XML code comments more productively, because the editing facilities in Visual Studio do not seem to scale when I want to write more elaborate comments (with bullet lists, tables and…
Ivan Zlatev
  • 13,016
  • 9
  • 41
  • 50
4
votes
4 answers

Is it possible for Visual Studio 2008 Automatically create XML Comments tags without "Generate XML documentation file" checked (VB.NET only)?

When in VS 2008 if a developer hits the ''' it generates the XML comment tags for you, but this only works when the project setting for "Generate XML documentation file" is checked. Is there a way to tell VS to generate the XML Comment tags,…
user117499
4
votes
2 answers

XML comments in Resources.Designer.cs?

In my Visual Studio 2008 project, I have this project with Resources.resx which contains images and strings. In order to force myself and everyone else to write at least the XML comments, I enabled the generation of XML comments in the build tab of…
hangy
  • 10,765
  • 6
  • 43
  • 63
3
votes
1 answer

xml-comments of nuget package do not show up

I have created my own nuget package: https://www.nuget.org/packages/Chia-Client-API/ In the code of the package, I documented all functions with xaml comments: /// /// returns all subwallets of the currently logged in wallet ///…
julian bechtold
  • 1,875
  • 2
  • 19
  • 49
3
votes
1 answer

External comments are included in the reverse order, .Net Visual Studio

ETA: Visual Studio 2010 VB Express edition exhibits the same behaviour. ETA: Visual Studio 2010 C# Express edition does NOT exhibit the same behaviour. In VisualStudio 2008 VB Express edition, I specify the following comments: ''' '''…
Jules
  • 4,319
  • 3
  • 44
  • 72
3
votes
2 answers

Closed generics in .NET XML comments

If i have the following function: void ReadData(Action action) {} how can i reference it in seealso construct? complains "The character '<' cannot be used in an attribute value".…
UserControl
  • 14,766
  • 20
  • 100
  • 187
3
votes
1 answer

Different colors in C# XML documentation comments

I'm trying to have different colors of text in the XML doc comment like how the word true, false and Window are in blue and green colors in the picture below. I tried decompiling the code that had these but the xml doc was different and there's no…
Mohammadios
  • 45
  • 1
  • 4
3
votes
0 answers

XML Commenting -- How to seealso to the method overload page?

Possible Duplicate: How to make a cref to method overloads in a tag in C#? How can I XML comment my code so that I point to something like this instead of each individual method? ComputeHash Overload /// public…
michael
  • 14,844
  • 28
  • 89
  • 177
3
votes
1 answer

How to show content inside see cref in XML comment from Intellisense and DocFx?

I have used XML comment on a property which is a type of List. However when I hover my mouse to that property, Visual Studio shows it as List. When I build the documentation with docFx, it still renders the comment as List instead of…
Unknown
  • 778
  • 1
  • 7
  • 16
3
votes
1 answer

XML Comments stored inside external file is not showed by Intellisense

I followed this MSDN guide for commenting my code. I discovered i can use external files to achieve the same result in a more clean way. However, my IntelliSense don't show those comments on Visual Studio (in this case the file is stored in the root…
Newbie
  • 31
  • 1
3
votes
2 answers

Commenting out XML

Consider this piece of XML: Is there any way to comment out MouseDoubleClick="item_DoubleClick"? This attempt…
user181813
  • 1,861
  • 6
  • 24
  • 42
3
votes
1 answer

Checking for handling of exceptions in xml comments?

Is there any C# code analysis tool that can verify if exceptions that are in the XML comments are handled somewhere up in the call chain? Assuming only exceptions that need to be handled specifically are xml commented it would be rather useful.
Carl R
  • 8,104
  • 5
  • 48
  • 80
3
votes
2 answers

Hide XML comments in Visual Studio 2017 (version 15.5.1)

When collapsing the XML comments for methods etc. It used to be that the summary was hidden. As I would like it to be. Then in VS2015 they broke this. I asked a similar question about VS2015 and got a nice workaround here - to use . The…
ispiro
  • 26,556
  • 38
  • 136
  • 291
3
votes
3 answers

Visual Studio XML summaries not working

When I used to use Visual Studio I could use /// to declare a summary of my method at the and it would autogenerate all the tags and add a line for any params however after installing Visual Studio 2015 I no longer seem able to do this by default.…
Antonio Gravano
  • 153
  • 1
  • 11
3
votes
2 answers

Where is the snippet for a method's XML summary?

I'm referring to the snippet that's used when typing /// before a method. I've found something for JavaScript (C:\Program Files (x86)\Microsoft Visual Studio 14.0\JavaScript\Snippets\1033\XML Comments) but changing it didn't affect the C# XML…
ispiro
  • 26,556
  • 38
  • 136
  • 291
1 2 3
…
20 21