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

Getting XML comments from multiple .csproj files to populate in Swagger UI

I know that similar questions have been asked here but I'm truly at a loss. I currently have around 5ish .csproj files as a part of a web application that all contain XML comments. Proj1 is the only one that is currently populating those comments…
Kaila Williams
  • 1
  • 1
0
votes
0 answers

What is the XML comment for return with cref of ActionResult>

If my API function is public ActionResult> GetAsync() How do you denote the cref of the return in an XML Comment? I tried /// but got the error: XML comment on 'member'…
Robert Achmann
  • 1,986
  • 3
  • 40
  • 66
0
votes
0 answers

VS 2022 - Add multi language code summaries

I'm currently working on a growing shared codebase. I'd like to add method summaries (XML comments) in multiple languages - the codebase has been used by Italian programmers until today, but it's now becoming international. I'd like to mantain…
IFrank
  • 419
  • 1
  • 5
  • 12
0
votes
0 answers

XML comment not showing descrition

I have an xml comment on a function that throws a std::runtime_error. While the intellisense shows the exception type that is thrown, it isn't showing the description. I searched about it but nobody seems to have a similar problem. I also tried…
K. Dimitropoulos
  • 43
  • 6
0
votes
2 answers

How to add comments in XML using python

XML i am parsing: 100 Apple Orange …
Anonymous
  • 59
  • 6
0
votes
0 answers

C# XML comment to say 'no exceptions thrown'?

In C# XML comments, we have the tag to say that a method throws a particular type of exception. What is the best way to tell the library users that a method does not throw any (expected) exceptions? Is the absense of tags…
Sergey Slepov
  • 1,861
  • 13
  • 33
0
votes
0 answers

CDATA sections and comments are lost when parsing XML with ElementTree

I am editing xml files, I ran into the problem that when changing a file in a python script, its structure is lost. Xml file:
firstText …
Fedor March
  • 67
  • 8
0
votes
1 answer

Intelli sense not showing for custom methods with xml comments

I have an interface with XML comments on namespace NamespaceName.Core.Services { public interface ITransaction : IDisposable { /// /// Sends message into the given queue, optionally at the scheduled time provided …
imsan
  • 359
  • 4
  • 17
0
votes
1 answer

Capturing commented text in an XML

I am trying to collect information from the World Bank. In particular, data from this website. https://microdata.worldbank.org/index.php/catalog/3761/get-microdata The "DDI/XML" link contains the metadata behind this dataset. If you download the…
Kah
  • 492
  • 1
  • 5
  • 17
0
votes
1 answer

VS 2019 - quick action menu items missing

I have two Win10 PC, both with the same installation VS2019 Enterpsrise(Version 16.11.15). Almost the same extensions. But in one VS installation, quick action menu and it's options look like on the picture below. add missing param nodes make…
KeiserSoze
  • 53
  • 10
0
votes
0 answers

XmlReader and malformed comments

I am using this code to load XML that has the potential for errors (human edited). $xmlReaderSettings = [System.Xml.XmlReaderSettings]::new() $xmlReaderSettings.CloseInput = $True $xmlReaderSettings.IgnoreWhitespace =…
Gordon
  • 6,257
  • 6
  • 36
  • 89
0
votes
1 answer

Preserve comments outside the root element of xml file

I am updating the xml file using python xml module and I want to preserve all the comments, using insert_comment variable is preserving the comments inside root element but removing outside/end of the xml file. Is there any way to save those…
Aryaman Gupta
  • 616
  • 1
  • 8
  • 20
0
votes
0 answers

How can I remove HTML comment in a .vue file?

I build a webpack project, to compile my .vue files. Then I write some HTML comments in the .vue file, and I build file using webpack, while the mode is "production". But when I browse the project in browser developer tools, I can catch sight of…
quanxin
  • 1
  • 2
0
votes
1 answer

API Documentation using XML Comments in SwaggerHub

I am trying to update API documentation for REST APIs. Currently, I have a C# Asp.net Web API code and Swashbuckle.AspNetCore. I am editing and adding XML comments in C# using Visual Studio to update the API documentation. Is there a way I can do…
GayathriS
  • 1
0
votes
0 answers

Calculating % of types and members which have XML comments

Does anyone know of an easy way for calculating what percentage of types, methods, and properties in a C# project are decorated with XML comments? I am considering ways of improving on our code documentation. A team I joined a few months ago is not…
kamilk
  • 3,829
  • 1
  • 27
  • 40
1 2 3
…
20 21