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

Does eclipse support xml comment description like Visual Studio?

I'm trying to switch a project from Visual Studio to Eclipse. In Visual Studio you could comment functions and parameters with xml comments. These comments where then shown in the code completion. /// /// The function HotKey.DeInstallKey()…
LukiLeu
  • 11
  • 4
0
votes
0 answers

How do I get the name used in the XML documentation for a .Net Type

I have an API project that uses .Net's XML documentation. This results in MyApp.dll getting a MyApp.xml file with all the code comments, which looks something like this: MyApp …
Keith
  • 150,284
  • 78
  • 298
  • 434
0
votes
1 answer

Process custom xml elements in xml document code comments for MSDN style Help files

I am looking for a way to build Help files that include custom XML elements for a large project. I want to add my own element similar to the Summary element and have the help files include it. I have Sandcastle and Ghost Doc Pro installed. I have…
SimperT
  • 2,837
  • 2
  • 15
  • 19
0
votes
6 answers

How to comment my XML files in Android Studio

I am learning Android and want to be able to add line comments to my XML so I can remind myself what things are doing. Is there an accepted practice for this, or is it possible in Android Studio? I recall reading that comments in XML are hard, so I…
AJJ
  • 2,004
  • 4
  • 28
  • 42
0
votes
0 answers

Unity XML Documentation Comments how to customise auto-generate

In Unity Monodevelop C#, how do I add a "comment" line top & bottom, so that it auto-generates as part of the XML documentation auto-completion? Currently, when /// is pressed above the class/method/etc, it auto-generates this: /// …
user3477955
  • 91
  • 1
  • 11
0
votes
1 answer

C#: Writing summary for properties with different accessors for getter and setter

I'm very disciplined in writing detailed summaries of interfaces, classes, properties and methods. It's while I have in focus to share my code to anyone beeing able to read without any expenses in unnecessary explanations. I'm following a personal…
codekandis
  • 712
  • 1
  • 11
  • 22
0
votes
2 answers

Addin to add XML comments for private variable

Just like Ghostdoc is there any add-in for Visual Studio 2008 that can automatically add XML comments for private variables, as Ghostdoc and few others doesn't support private variables.
H Sampat
  • 1,039
  • 1
  • 9
  • 10
0
votes
1 answer

Visual Studio 2008 - Where is the setting to switch on /off XML auto-comments?

As the title says, my XML auto-comment feature (/// or ''') has stopped working! Spent half an hour trying to find it in Tools/Options/Environment, Googled it, rebooted, etc still no luck :-( Anyone knows where it is please?
joedotnot
  • 4,810
  • 8
  • 59
  • 91
0
votes
0 answers

Visual studio XML comments. UNC path to document instead of http link to webpage

When commenting my code, I know that I can link to a webpage like this: /// But is it possible to reference an excel document (for example) on a samba share? ie.: ///
Quantum_Kernel
  • 303
  • 1
  • 7
  • 19
0
votes
1 answer

XML comment for byte[] without errors

I'm trying to write a XML comment for the type byte[]. Unfortunately, the standard syntax: causes an error when executing the Remove and Sort using VS command, as described here:…
Teejay
  • 7,210
  • 10
  • 45
  • 76
0
votes
1 answer

Is there a point in writing the member type of a class for each class member?

Is there a point in writing comments in code like this? /// /// Name of abc - public property. /// In visual studio, the intellisense has icons for each type of class member (field, property, etc), so I don't see the point of…
GurdeepS
  • 65,107
  • 109
  • 251
  • 387
0
votes
2 answers

Copy comments with T4 template

I'm generating a class from an interface using T4 templates, and I want to be able to copy xml-comments from the interface to the class methods. Is it possible and if yes, how? In my template I am just taking the interface methods and copying them…
Egor Pavlikhin
  • 17,503
  • 16
  • 61
  • 99
0
votes
1 answer

Cannot see xml comments from dll in a project

I created a .dll with xml commented functions and subs, like: ''' ''' Gets the Path of this assembly ''' ''' Assemblypath ''' Public Function GetactiveProgrammPath()…
ruedi
  • 5,365
  • 15
  • 52
  • 88
0
votes
1 answer

Adding cell comments from raw xml for Excel 2007 using java

I need to create cell comments for existing excel file by extracting the xlsx file and using raw XML file. Is it possible to do it in java without using Apache poi library?
Soorya Prakash
  • 921
  • 3
  • 9
  • 29
0
votes
2 answers

XML Comments for nullable 2D Array

How do I correct specify the XML Comments for a 2D array of nullable doubles? The following gives me syntax error. /// The . public double?[,] Get2DArray() { ... } If it was just a 2D array of doubles…
openshac
  • 4,966
  • 5
  • 46
  • 77
1 2 3
…
20
21