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
2 answers

How to use #if in an XML comment

I'm writing a library with source code common to the server and the client. The problem I have is inside XML comments, where sometimes the client and server documentation differs, something like: /// /// Does something. ///…
Patrick8639
  • 31
  • 1
  • 7
0
votes
0 answers

XML comments for objects using WithEvents not showing

XML comments do not show up when an object instance is defined using WithEvents; however, comments will show up for everything else. How do I resolve this? EDIT ''' ''' Represents a control that…
John89
  • 45
  • 1
  • 7
0
votes
1 answer

Is it possible to make VS specify the kind of type when building xml-comments?

I'm trying to create documentation for my code and I'm using xml-comments for it. When a class is documented like the following: /// /// Main presentation window /// public partial class mainWindow : Form { } The xml file will…
Bildsoe
  • 1,310
  • 6
  • 31
  • 44
0
votes
1 answer

VS2019 - Automaticly generate XML comment for methods and classes when you save the file

In Visual Studio, you can write /// to create an XML documentation comment above a C# method or class. The problem is that you have to manually type three slashes, which is too much for some developers at a company I work at. Therefore, someone has…
Kevin Mohar
  • 1
0
votes
1 answer

xmlstartlet how can I insert line above node

I want to add a commentline inside a xml file above the node using xmlstartlet Harry Potter 29.99 I…
GJF
  • 77
  • 7
0
votes
1 answer

Punctuation marks in C# XML comments

Should I add punctuation marks (e. g. ".") in my c# xml comments? In the official Microsoft xml comment documentation there is now statement. Also you can see in that in this documentation there are some comments with an ending "." and some…
sampa
  • 535
  • 4
  • 27
0
votes
1 answer

How can I export XML code documentation in vb.net?

In vb.net I can write an XML documentation by using some tags, like the following ''' ''' Hello there! ''' In Java, I simply can export my Javadoc documentation in a single click (it generates an Html file). Is there a way to do…
Calaf
  • 1,133
  • 2
  • 9
  • 22
0
votes
3 answers

In C#, is there a way to access xml comments (the tags in VS) in the source code at runtime?

In Visual Studio, xml comments can be added to methods/classes to provide documentation. See http://msdn.microsoft.com/en-us/magazine/cc302121.aspx. Visual Studio generates files from these xml comments and exports them, so they are accessible for…
Yuf
  • 610
  • 2
  • 6
  • 14
0
votes
1 answer

Is there a converter that converts XML to YAML and includes comments?

I'm trying to find a service, library, utility, whatever that converts XML to YAML and includes comments. It's easy to find a lot of XML to YAML converters, but I can't find one that includes XML comments in the YAML output. For example, using the…
Ray Dixon
  • 3
  • 3
0
votes
1 answer

Is it possible to have a ctrl+click able link to a file with relative path in the comment

I need to link a file in a comment so that others can click it and the explorer opens the folder or the file opens I need something like this: /// /// Does something see file://$(SolutionDir)/SomeFolder/somefile.txt" /// public…
MidnightCommander
  • 5
  • 5
0
votes
0 answers

Documenting members of members in C# XML-Comments

How do you document members of members in C# XML-Comments with the
blenderfreaky
  • 738
  • 7
  • 26
0
votes
1 answer

Create a XML from SQL Server

I need some help. I'm trying to create an XML with this query: WITH XMLNAMESPACES ('Envelope' AS soapenv) SELECT * FROM CrearViaje4 JOIN transporte ON CrearViaje4.Cod_viaje = transporte.Cod_viaje JOIN depositoSalida ON…
Lopez Lopez
  • 5
  • 1
  • 3
0
votes
1 answer

How does xml comments work between projects in one solution

I'm setting up xml comments through properties in project in solution. I want this comments to be seen in other project in same solution. However project and xml being refereenced in bin near .exe isn't enough. I tried adding the hard link to other…
Przemysław Lunic
  • 365
  • 1
  • 4
  • 12
0
votes
0 answers

How to create an XML root/prolog comment using PowerShell?

I'm trying to add a root comment to an XML file that doesn't have one. I'm close, but can't get it in the root/prolog area and instead can only get it injected after the first element. (preloading [xml]$UpdatenuspecFile=somefile.nuspec) What seems…
bcurran3
  • 1
  • 3
0
votes
1 answer

Is there a way to put formatted maths into XML commenting C# Visual Studio?

I want to be able to put a formatted mathematic equation into my XML comments, is there a plugin to allow me to do this or maybe some other way? I am currently using this: /// /// e^-x/(1+e^-x)^2 /// public double Sigmoid(x) =>…
user10124074
1 2 3
…
20 21