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

Warnings for bad XML comments - How to enable?

I want warnings for bad XML comments. They're turned on in Project Options and there are no Compiler Directives inside the unit with the bad xml comments, but I'm not getting any warnings. What else could hide them? Günther the Beautiful gave the…
RSE
  • 322
  • 1
  • 10
0
votes
1 answer

XML comments - refer to property in class

How describe in XML comments that property Encoding is intiliaze to default. public class Settings { public Encoding Encoding{get;set;} /// /// Initialize a new instance of a HttpRequestSettings type. …
imodin
  • 821
  • 3
  • 12
  • 23
0
votes
1 answer

Correct XML comments for return value of generic method

I need create XML comment for return value of method Login. This method returns object type of Result. This object contains session id if login was successful and if login was unsuccessful contains error message. I don’t know how decribe this in…
imodin
  • 821
  • 3
  • 12
  • 23
0
votes
1 answer

Configuring GhostDoc to comment public accessors only

How can I configure GhostDoc to comment only public accessors only? I've looked at the "rules" configuration, but did not see any information/variables indicating accessor type.
d.moncada
  • 16,900
  • 5
  • 53
  • 82
0
votes
1 answer

Is there a way to document side-effects of a method using the .NET XML documentation tags in the source?

Is there a way to document side-effects of a method using the .NET XML documentation tags in the source? If there is no tag specifically for this, what is the recommended way to document side-effects?
LJNielsenDk
  • 1,414
  • 1
  • 16
  • 32
0
votes
1 answer

Ordered lists in Doxygen comments from C# .NET comments

I've got some C# documentation comments that looks like this: /// /// Pre-Conditions: /// /// /// 1. The sky must be clear. /// /// /// 2. It must be night time. /// /// ///…
Becca Dee
  • 1,530
  • 1
  • 24
  • 51
0
votes
2 answers

How to autocorrect xml documentation of methods

In the below code in xml documentations there is mismatch between the names of parameters in method's arguments and name of parameters in xml documentation. Is there any way to auto correct the xml documentation signature or any feature provided in…
Raghav
  • 8,772
  • 6
  • 82
  • 106
0
votes
1 answer

Remove empty comment tags using XSLT

I have an input xml suppose of the form I am using XSL to transform this XML, but when I parse this XML I am getting below error message "Error serializing file java.lang.ArrayIndexOutOfBoundsException:…
Vix
  • 63
  • 7
0
votes
1 answer

GhostDoc - Updating derived class comments

I have an interface (ISomeInterface) with full xml comments, and some derived classes with matching xml comments. If I change the comment in the interface, is it possible to update the comments in all derived classes with GhostDoc (or any other…
Brett Postin
  • 11,215
  • 10
  • 60
  • 95
0
votes
1 answer

Finding uncommented methods in a C# project

Is there a way to find the number of methods in the assembly which do not have any xml comment on them. public int Sum(int i, int j) { .... }
AsitK
  • 651
  • 1
  • 4
  • 14
0
votes
1 answer

Generate JavaScript Intellisense Documentation Comments with CoffeScript

I am working with CoffeeScript and I want to supply Visual Studio 2010 JavaScript Intellisense hints as for example Jquery does. The comments have to be in the format ///Description of the Function The only way I can see to…
Marius Filipowski
  • 3
  • 2
0
votes
2 answers

Putting comments in XML that is present in my C# XML comment blocks

I am using a code example block in an XML comment as a simple way to give the user an idea of what the XML looks like. This is a very rough solution and the user will eventually be provided with XML Schema for the xml string. However, for now I'm…
Dave
  • 14,618
  • 13
  • 91
  • 145
-1
votes
2 answers

Automatically remove comments from source control or keep code comments in separate physical files

Is it possible to automatically remove code comments in Visual Studio files before committing to source control, or is it possible to virtually have comments in files but physically store those in separate files? The end goal is not to have comments…
BuzzBubba
  • 723
  • 1
  • 8
  • 20
-1
votes
1 answer

How to write more detailed XML comments in C#?

I was writing some XML comments for some variables and discovered that if I have a short summary block, when I hover over the variable I get tooltip with that summary. However, if I have a long tag it stops showing. Here's an example: ///…
Adrian
  • 10,246
  • 4
  • 44
  • 110
-4
votes
1 answer

Why do some XML-Comment show up strangely?

Reproduce as follows: Create a WPF application (.Net 4.8). Click on the codebehind tab. Hover over the class name (MainWindow). You will now see a popup saying MainWindow instead of saying Interaction logic for MainWindow.xaml This is not the…
ispiro
  • 26,556
  • 38
  • 136
  • 291
1 2 3
…
20
21