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
1
vote
1 answer

Should you use XML comments on field variables, properties & constructors?

So far I understand that its good practice to XML comment a classes methods but is there a standard for how much you should use XML comments? Should I be using them to document field variables, properties & constructors or is that just overkill? Had…
cosmicsafari
  • 3,949
  • 11
  • 37
  • 56
1
vote
2 answers

Doxygen C# XML comments and generics do not generate links in HTML output

I could not find anything about on the net and i´m quite clueless to the XML comment support in doxygen. My problem is as simple as this: /// Which seems to me to be the correct way to reference an open…
sanosdole
  • 2,469
  • 16
  • 18
1
vote
0 answers

Reading Xml Documentation generated by visual studio from c#

We need to parse out and display class documentation for certain classes from Xml documents produced during our build process (for our .Net assemblies) for certain web-service data contracts on a website? We can use Linq2Xml and do it the hard way…
SharePoint Newbie
  • 5,974
  • 12
  • 62
  • 103
1
vote
1 answer

Custom schema for XML comments in Visual Studio for C#

When I type "///" in the editor, Visual Studio creates an empty comment body with the < summary > and other tags. I can then type the "<" and VS suggests a list of recommended tags. How can I make the IntelliSense to suggest my custom tags…
dmimat
  • 26
  • 3
1
vote
0 answers

"--" is not permitted within comments: why this error occurs

I have used 1 comment inside an xml document. It is working fine on my system. But when I have deployed my software to the server, it is giving error on this line. "--" is not permitted within…
pankaj_ar
  • 757
  • 2
  • 10
  • 33
1
vote
1 answer

Refer to another section in C# XML documentation comments

Does anyone know whether it is possible to refer to another section from the text of another one, e.g. to the ‘returns’ section from the ‘summary’ section or vice versa (within the documentation of a given method) and have a hyperlink generated by…
juniper
  • 311
  • 5
  • 13
1
vote
1 answer

Visual Studio and XML Commenting in Javascript makes "public" methods disappear in intellisense

I was elated to find out that I could use XML commenting in my javascript (i.e.): /// Determines the area of a circle based on a radius parameter. /// Give this dude a NAME! ///
Todd Vance
  • 4,627
  • 7
  • 46
  • 66
0
votes
0 answers

Is there an equivalent vor CS1591 (Missing XML comment) in visual Basic.NET?

I have got a VB Project with the option "Generate XML Documentation" activated. Although some public Types and members don't have a comment, there is no warning at all, unlike in my C# projects. Do I have to enable/disable anything, or is there no…
Peter Stock
  • 301
  • 1
  • 7
0
votes
1 answer

Visual Studio 2010 Javascript comments stopped working

When I type /// visual studio no longer adds xml comments in to my javascript document. I've installed a number of extensions recently and wondered if these may have caused it, one of which recently expired (re-sharper). I've tried disabling and…
David Wilton
  • 344
  • 2
  • 11
0
votes
1 answer

Atomineer Utils VB.NET XML Comment Documentation Not Working

I just downloaded the trial for this application and it doesn't seem to work. I went through the Quick Setup guide and it all looked great. Now when I place my cursor on a member of any type and press Ctrl+Shift+D it does nothing. I placed it on…
Shane LeBlanc
  • 2,633
  • 13
  • 42
  • 74
0
votes
1 answer

XQuery and Server Sides Includes

How can I instruct XQuery to copy these SSI directives (HTML comments) from an XQuery file (.xq) to the output html file. I'm using Saxon and I'm getting…
TechAurelian
  • 5,561
  • 5
  • 50
  • 65
0
votes
3 answers

Tool to reformat xml-comments (Visual Studio 2008)

does anyone know of a macro or add-on for VS 2008 which reformats xml-comments? There has been this really smart CommentReflower for the older version of VS, but I couldn't find a release supporting VS 2008. Any ideas? Thanks in advance! Matthias
Mats
  • 14,902
  • 33
  • 78
  • 110
0
votes
1 answer

Documenting *not* overriden methods with different XML comments

I have some base class and multiple classes inheriting from it. Those derived classes usually won't override the default constructor. Nevertheless, I'd like to change the documentation of that default constructor (usually inheriting the class…
Tymur Gubayev
  • 468
  • 4
  • 14
0
votes
1 answer

How to reference a nested generic type in C# doc comments

In C# it is possible to add doc comments to methods. In the description it's possible to put a reference to another type using the tag. When putting a generic type in the cref attribute I gather that I should use { and } instead of…
Martin Brown
  • 24,692
  • 14
  • 77
  • 122
0
votes
0 answers

Cannot deserialize XML with xml-comment using ordered elements

If I deserialize XML which include a comment-element and it is deserialize to a class with ordered properties I get the exception: There is an error in XML document (4, 25). Unable to cast object of type 'System.Xml.XmlElement' to type…
MrCalvin
  • 1,675
  • 1
  • 19
  • 27
1 2 3
…
20 21