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

Direct Visual Studio F1 keypress to an internal help server for components I have authored

I have my code documented with XML comments and am learning how to use SandCastle to generate html API help documentation. I'm going to publish that html documentation to an internal website. How can I register this site with visual studio, or my…
Sean B
  • 11,189
  • 3
  • 27
  • 40
1
vote
1 answer

c# Intellisense VS2013 tooltip doesn't show XML comments (i try all)

I read all questions about intellisense problems but my intellisense doesn't work. Visual Studio Ultimate 2013 I don't use any extension like Resharper, ghostdoc and so on All XML documentation files about custom and not custom classes are inside…
Enrico Tirotta
  • 313
  • 1
  • 4
  • 14
1
vote
1 answer

Visual Studio XML comments from .cs to file in database project

Is it possible to create a cref from c# codes to a file in a database project so you can ctrl + click to navigate to it like you can with .cs files? e.g. Say I have some data access code that uses a pacakge/procedure in some other database project: …
jparram
  • 804
  • 8
  • 24
1
vote
1 answer

How do I show content from an included Xml document in Intellisense tooltips using tag

I am trying to declutter my classes that contain a fair amount of code. I want to also document and document well. Unfortunately for me to do this all in one file creates chaos for the eyes personally. It's gross and for quick developing it creates…
David Carrigan
  • 751
  • 1
  • 8
  • 21
1
vote
1 answer

Framework goto definition shows comments, are these generated from xml comments?

I was mildly surprised recently to discover that my carefully crafted xml comments weren't showing up in intellisense for my colleagues. Having always used the associated assemblies with project references, I hadn't realised that you had to export…
Benjol
  • 63,995
  • 54
  • 186
  • 268
1
vote
1 answer

Add Line in Sandcastle generated example code

I want to add a line in Sandcastle generated example code This is what i have written so far /// /// Represents the SQL Connection for interaction with the Database /// /// Add these lines in the Web.config or…
Pankaj
  • 2,618
  • 3
  • 25
  • 47
1
vote
0 answers

XML commet for return collection of type T

I would like specify in XML comments that method return collection of IEnumerable. What is correct format for XML tag . /// /// Extensions methods for class /// public…
jose
  • 63
  • 4
1
vote
2 answers

Outputting an ASP.NET Web Site's XML Comments

I would like to document my VB.NET web site's source code. How can I convert XML comments in a VB.NET ASP.NET web site to an XML documentation file? I do not see an option to generate an XML documentation file in the VS web site's property pages.
ChandaMAMA
  • 73
  • 1
  • 11
1
vote
1 answer

Visual Studio 2010 Tooltip Comments for C++ methods

My question How do I write comments for my class methods in C++ using Microsoft Visual Studio 2010 and make them appear in the tooltip? Maybe it should work, but I do not see my comments appear in the tooltip. An example
Michiel Pater
  • 22,377
  • 5
  • 43
  • 57
1
vote
2 answers

How do I put XML code into IntelliSense comments?

I have the following code block. /// /// AMethod produces this XML: /// /// public void AMethod() { } When I do this IntelliSense does not print the XML, if I hover over AMethod. How…
Daniel Ball
  • 1,613
  • 2
  • 11
  • 14
1
vote
1 answer

Collapse all xml comments in Visual Studio 2012

I have recently been given an existing project to work with that is very comment heavy, especially in terms of XML comments. In many cases the methods are short and simple and the XML comments take up more than half of the lines in the file. As much…
joelmdev
  • 11,083
  • 10
  • 65
  • 89
1
vote
2 answers

Reading XML comments

I'm trying to use windows's task scheduler xml file. For anyone who doesn't know, xml file looks like this:
ekrem777
  • 35
  • 2
  • 8
1
vote
1 answer

How to get XML comments to appear in Visual Studio Class Wizard decriptions

I have put XML comments in a C++ source file that IntelliSense appears to pick up and use. It creates a project xml file, and IntelliSense works when I edit the original source file (showing me comments when I'm selecting a member function or…
Dev93
  • 668
  • 1
  • 6
  • 18
1
vote
1 answer

Extending XML Comments Snippet in ASP.NET(VB/C#)

I am trying to expand the default XML Comments snippet. After doing some research, I found out what the file name where this xml is generated from-- VBXMLDoc.xml. But, I am not able to find it on my system. I am using VSTS 2012. For 2010, looks like…
DQELER
  • 133
  • 2
  • 7
1
vote
1 answer

How can I get XML comments to appear in generated XSD?

If I have XML documents that follow the following pattern, how can I generate XSDs for these documents but convert the comments to annotation tags? ABC …
CJ7
  • 22,579
  • 65
  • 193
  • 321
1 2 3
…
20 21