397 questions
1
vote
0
answers
26
views
How do disable automatic closing tags in XML-DOC in Visual Studio
I'm programming C# in Visual Studio 2022. I often write XML-DOC. What is particularly annoying for me, is that when I write something like <item>, as soon as I enter the > visual studio adds ...
- 1,913
0
votes
1
answer
77
views
C# documentation link to method but show only method name without parameters
I want to show link with only method name as text. Is there a way to set link to method and change text? This is all I know: <see cref="ScrapePatentsByWindows"/> and when you hover ...
- 105
-1
votes
1
answer
62
views
Floating (with scroll) text in AsciiDoc?
New to AsciiDoc. I'm wondering if there is a way to have text "float" with scroll (similar to a floating header row in Excel). I have a single word that I've entered between separator lines ...
- 1
0
votes
0
answers
66
views
C# summary a class ,and have the docs in the instance
I'm still learning C# and I don't know if it's possible but if I summary a class, I want this comment to show when I instantiate it in another class.
I want to do this:
/// <summary>
/// This is ...
- 11
0
votes
1
answer
2k
views
What is the simplest way to add XML documentation to Swagger?
This Q&A question is meant as a helpful references for myself and hopefully for the community. I use Swagger for all my web APIs, and like it to include my source code documentation, as Swagger is ...
- 10.7k
2
votes
0
answers
88
views
Does RAD Studio (Delphi) support inheritdoc tag?
Does RAD Studio for Delphi support <inheritdoc/> tag for XML documentation.
If yes, how to enable it?
Like in C# or Java.
I have tried an empty <inheritdoc/> and with reference <...
- 21
1
vote
1
answer
208
views
No XML documentation / IntelliSense for WPF
I'm using Visual Studio 17.5.4 and .NET SDK 7.0.5
Upon creating a new WPF application, I have no XML documentation available in IntelliSense for the WPF library.
Browsing to source (F12) shows the ...
- 3,211
-1
votes
1
answer
47
views
How to refer to class properties in XML docs C#?
Suppose I have a method in a class
public class MyClass{
public int MyInt;
/// <summary>
/// Prints out the value of <paramref name="MyInt">
/// </summary>
...
- 633
0
votes
1
answer
797
views
Why am I not getting warnings for missing xml documentation on public API?
My C# project (a Unity Package library) is not getting warnings on missing xmldoc of public classes, properties or methods.
I want to ensure all of my public API has XML documentation in code, but I'...
- 1,837
0
votes
1
answer
934
views
XML Tags For Warnings/Important Comments When Documenting C# Code
Are there any xml tags recognised by any official C# documentation (and recognised by IntelliSense) that are used exclusively for content that serves as a warning or very important information ...
- 4,824
0
votes
1
answer
2k
views
Visual Studio 2022 Intellisense XML documentation started failing
I've been working on a long and convoluted C++ project in Visual Studio 2022, so I've been making sure to comment as much as possible and have been using the XML documentation summaries for most every ...
- 81
3
votes
0
answers
117
views
C# 10 nullable type "?" character display seems inconsistent in the Intellisense display of the XML documentation
Consider the following code snippet:
/// <summary>
/// Serializes this <see cref="ICollection"/>? object to a <see cref="string?"/>, skipping nulls.
/// </...
- 18.4k
2
votes
0
answers
1k
views
c# xml doc: show only the property name of <see cref="Class.Property">
I have added this xml doc to my method:
/// <summary>
/// Create an <see cref="ArgumentOutOfRangeException" /> with the message<br />
/// "The value '<paramref ...
- 3,579
14
votes
2
answers
14k
views
JetBrains Rider - is there an easy way to generate the XML documentation file?
VS has a checkbox that just builds the XML documentation file from C#. I couldn't find anything like this in JetBrains Rider's build settings. What's the easiest way to do this?
- 5,895
0
votes
1
answer
106
views
Is there any limitation on the number of topic references in ditamap
The DITAMAP loads the topic references in the DITAMAP dashboard very slowly in AEM, sometimes it hangs when there are a lot of topic references.
I have tried segregated by creating smaller DITAMAP's ...
0
votes
0
answers
378
views
How to extract an interface from a class with all its XMLDOC comments (class and members like properties and methods)?
I use visual studio 2019
I have a class
public class User
{
/// <summary>
/// Create user in DB
/// </summary>
/// <param name="user"></param>
...
- 808
4
votes
1
answer
698
views
Xml Doc comments in c# embedded resources on .NET (Core)
I've got a c# project migrated from .NET framework to .NET Core (and then .NET 5).
We haven't touched our .resx files at all in a couple of years, but now that I updated a .resx file, the Resources....
- 1,262
0
votes
0
answers
2k
views
C# generating XML documentation
I have created a new C# WinForms project running on .NET Framework 4.7.2 and I would like to create a pdf documentation from XML generated file. I've managed to install VS docfx.console package as ...
1
vote
1
answer
281
views
How to add c# xml cref comment for a complex expression?
I would like to add a cref for the expression Bars[0].Name
Here is the code but it generates 2 warnings
using System.Collections.Generic;
namespace MyProject
{
class IFoo
{
public ...
- 2,043
0
votes
0
answers
85
views
NodeJS xmldoc check if pair (element, value) exists
I'm trying to check if a pair (element, value) exists in XML. I'm using xmldoc
XML file:
<?xml version="1.0"?>
<listings>
<listing>
<id>1</id>
...
- 2,403
1
vote
1
answer
932
views
Reference the Generic Type in an XML Documentation comment
I have a interface like this:
public IApiController<T> where T: IEntity
{
/// <summary>
/// Returns Entity with Id = <paramref name="id"/> of Class <typeparamref ...
- 169
2
votes
1
answer
1k
views
Do not copy XML documentation files from NuGet packages into bin
I can't seem to find a way to prevent XML documentation files from NuGet packages (such as Dapper for example) from being copied into bin folder. I'm using VS2015.
- 23
0
votes
0
answers
74
views
algorithm to sort xml attribute values doesn't working. It is written in C#
for (int i = 0; i < node1.ChildNodes.Count; i++)
{
if (i == 0)
{
XmlNode node2 = node1.FirstChild;
XmlNode node3 = node2;
...
- 1
8
votes
3
answers
1k
views
VS Intellisense: Show INDENTED multiline code example on hover-over
Is such a thing possible? If it's not clear what I'm talking about, here's a detailed example:
Take this quick utility class I wrote a few weeks ago (details omitted), along with the example I want ...
- 115
19
votes
1
answer
21k
views
.NET Core - System.Private.CoreLib.dll vs System.Runtime
In a .NET Core App, if I do
typeof(DateTime).Assembly.Location
I get
C:\Program
Files\dotnet\shared\Microsoft.NETCore.App\3.1.4\System.Private.CoreLib.dll
But the documentation for the DateTime ...
- 2,762