313 questions
3 votes
5 answers
187 views
Using Perl string substitution, how to delete lines containing (indented) XML comments only?
I wrote some server providing XML output with some debugging comments, like this (just a short extract): <Result> <Channel>DB1.PagesFreeMinPct</Channel> <Value>55.578&...
12 votes
0 answers
919 views
Documentation comments for record types with primary constructors in C#
I can declare a C# positional record like this: public record Box(double Capacity); which results in the definition of a record class named Box with a property named Capacity, as well as a primary ...
0 votes
2 answers
234 views
Is there an alternate way to add Swagger comments?
I would like to get method comments that are in a manager class that is directly called by a controller to show up in Swagger UI. The only way I know of to do that is to copy and paste the comments ...
0 votes
1 answer
67 views
Documenting *not* overriden methods with different XML comments
I have some base class and multiple classes inheriting from it. Those derived classes usually won't override the default constructor. Nevertheless, I'd like to change the documentation of that default ...
5 votes
1 answer
976 views
How to reference a nested generic type in C# doc comments
In C# it is possible to add doc comments to methods. In the description it's possible to put a reference to another type using the <see cref="..."/> tag. When putting a generic type in ...
2 votes
3 answers
2k views
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 ...
1 vote
1 answer
92 views
Mouse over variables and functions tips
I know that i need to add ///<summary> to have mouse over tips on functions and variables but is there a way to make this happen only with the // ? In the pre-built default functions i always ...
6 votes
1 answer
1k views
xml-comments of nuget package do not show up
I have created my own nuget package: https://www.nuget.org/packages/Chia-Client-API/ In the code of the package, I documented all functions with xaml comments: /// <summary> /// returns all ...
1 vote
1 answer
348 views
Visual Studio Refactoring changes to many things
Example: When i rename the following function public void Foo(){} to public void Bar(){} Then visual studio changes all constant strings, that contain the word "Foo" and replaces "Foo&...
1 vote
1 answer
444 views
XML comments cannot correctly reference properties named 'Item'
Given the following code: class FixedWidthReader<T> { public T? Item { get; private set; } /// <summary> /// Populates <see cref="Item"/>. /// </summary&...
0 votes
2 answers
156 views
How to add comments in XML using python
XML i am parsing: <List> <Item> <Price> <Amount>100</Amount> <Next_Item> <Name>Apple</Name> ...
0 votes
0 answers
160 views
C# XML comment to say 'no exceptions thrown'?
In C# XML comments, we have the <exception> 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 (...
0 votes
0 answers
655 views
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: <?xml version="1.0" encoding="UTF-8"?> <main&...
7 votes
2 answers
5k views
Visual Studio 2022 not showing parameter XML docs tooltips on mouse over
As pictured, the "param" part of the summary is not showing on mouse over panel. Should I expect them to be there or is the "param" functionality not working as I think it should? ...
0 votes
1 answer
472 views
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 { /// <summary> /// Sends message into the ...