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

What do brackets mean in C# xml documentation generated by ghost doc?

I generated xml-comments to a method with Ghost doc /// /// Determines whether [is lv class identifier] [the specified class identifier]. /// /// The class identifier. ///…
char m
  • 7,840
  • 14
  • 68
  • 117
0
votes
0 answers

Ignoring comments with StaX

Using the following code, I'm successfully reading XML files. However when a comment appears in the middle of a node, the reader is discarding the remainder of the node. For example: thisismydocument would result in a…
srodden
  • 57
  • 1
  • 4
0
votes
3 answers

Sandcastle not generating params or return

I have a Visual Studio C# project with XML documentation comments. I get a .xml file with , , and members. The text I put inbetween the tags is shown in the help file as well as Namespace, Assembly,…
Simon
  • 115
  • 2
  • 6
0
votes
0 answers

Describe generic of generic in XML documentations

In my interface I have the following method signature: ServiceResponse> Dictionary(DictionaryRequest request); I'm trying to add XML comment for that method like: /// /// Returns the dictionary of all codes…
Robert N. Dean
  • 1,219
  • 1
  • 14
  • 27
0
votes
1 answer

GhostDoc "Document this" not working for method with attribute

I am using GhostDoc and Visual Studio 2017. Now, if I have a method like this public string Foo() { ... } I can normally use GhostDocs "Document this" to generate an XML comment for the relevant method. However, if the method has any attributes…
Thomas Flinkow
  • 4,845
  • 5
  • 29
  • 65
0
votes
0 answers

Reference to dependent assembly in XML Comments

I have 2 class libraries projects A and B, and A depends on (has a reference to) B. In B I have a class to which I want to add XML comments, and mention a class in A using a . The problem is that because B doesn't have a…
Arnon Axelrod
  • 1,444
  • 2
  • 13
  • 21
0
votes
0 answers

Uncommenting in a .xml file with Powershell

I'm writing a script that replaces and delete some commented lines but the problem is the .xml file got more than only one thing which is commented and I only have to uncomment one of these. It would be no problem if there's everything written on…
Manuel Hedinger
  • 49
  • 5
0
votes
1 answer

comment and uncomment xml elements with python

I would like to comment and un-comment, selected element in XML. xml looks like this.
tgcloud
  • 857
  • 6
  • 18
  • 37
0
votes
0 answers

Publish Action NOT including class libraries comments.xml files

I have a solution that has two projects, and a nuget package: - WebApp.csproj - CommonClassLibrary.csproj - nugetClassLibrary.nuget The WebApp has a project reference to CommonClassLibrary.csproj, and a nuget package reference to nugetClassLibrary.…
Nathan Tregillus
  • 6,006
  • 3
  • 52
  • 91
0
votes
1 answer

Add comments in JAXB output?

I would like to add some comments to an XML file produced via JAXB, but as far as I can tell, this doesn't seem to be possible. The file that I'm producing is expected to be hand modified by humans occasionally, so I want to be able to provide some…
NateW
  • 908
  • 1
  • 8
  • 28
0
votes
2 answers

How to add XML documentation comments to Xamarin iOS Bindings Library?

I am implementing Xamarin iOS Bindings Library to bind an Objective-C framework. I would like it to contain XML documentation comments if it's even possible. Is there any way to grab them from Objective-C Headers or at least to add them manually to…
Olexander Ivanitskyi
  • 2,202
  • 17
  • 32
0
votes
1 answer

Writing comments in metadata

So I did some searching on google but did not find the answer or maybe did not understand the answer? I would like to write some comments into my code so even after release it will be still visible in the metadata.
daralim
  • 183
  • 10
0
votes
0 answers

In Swagger ASP.NET Core Production Environment, how to keep metadata from XML Comments?

From the Ahoy repository's examples (see the README), in the basic example, they do use XML Comments to generate some metadata for Swagger to serve up. However, they only configure it if the app is in the Development configuration. See that specific…
steamrolla
  • 2,373
  • 1
  • 29
  • 39
0
votes
1 answer

JDom How to comment an existing line

I am currently struggling to comment an existing line with JDom, best I would like to comment an entire node. SAXBuilder jdomBuild = new SAXBuilder(); jdomDoc = jdomBuild.build(fileLocation); Element root = jdomDoc.getRootElement(); …
B_PRIEUR
  • 160
  • 1
  • 1
  • 18
0
votes
1 answer

Visual Studio: Doc Comments that get updated when renaming classes/fields/methods

I have a class (written in C#) with some documentation comments: /// /// Abstract class defining a tolerance-based method for Equals. /// Tolerance must be defined in a derived class like this: /// class MyPrec : Precision { private…
Kjara
  • 2,504
  • 15
  • 42
1 2 3
…
20 21