xml-documentation Questions
8
Solved
Would you write xml-doc for a namespace? And if yes, how and where?
I would think, if it is possible, maybe an almost empty file like this:
/// <summary>
/// This namespace contains stuff
/...
Albrecht asked 27/4, 2009 at 12:5
5
Solved
I have used Sandcastle to document my class libraries recently. However, I have recently discovered that Sandcastle is no longer developed by Microsoft: https://archive.codeplex.com/?p=sandcastle.
...
Castalia asked 23/4, 2018 at 20:10
1
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 Date...
Eighteenth asked 1/6, 2020 at 8:47
4
Solved
I've created a 'Class Library' in C#, which has many functions with summary (XML documentation comments).
For example
///<summary>
///Adds the two numbres
///</summary>
public void Ad...
Snide asked 25/6, 2011 at 9:15
3
Solved
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...
Uttermost asked 30/7, 2020 at 17:53
2
Solved
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?
Twirl asked 2/1, 2022 at 18:32
4
Solved
In Visual Studio, how do I change the default XML summary comment snippet from three lines to one line?
Currently it provides this snippet when I type ///:
/// <summary>
///
/// </summa...
Swelling asked 26/11, 2011 at 13:58
1
Solved
I'm writing a small analyzer for C# projects that checks if the XML documentation generation is present and set up correctly. There are two options for to specify XML documentation:
An older Docum...
Ysabel asked 22/11, 2021 at 15:1
7
Solved
Writing some XML documentation for a predicate helper class. But I can't figure out I can refer to an Expression<Func<T, bool>> without getting a syntax error. Is it even possible? I ha...
Hairbreadth asked 26/3, 2009 at 8:55
3
Solved
I have 2 private consts and a public method:
private const byte _minAge = 24;
private const byte _maxAge = 29;
public bool IsInAgeRange() { ... }
I am adding XML documentation, and would like i...
Fossorial asked 17/10, 2012 at 10:37
2
I wonder how these XML references work, I'm just not getting why they work or why they don't work and I found nothing about that.
Here's an example:
type
TOuterClass= class
strict private
type...
Argos asked 25/3, 2014 at 18:3
8
Solved
When writing xml documentation you can use <see cref="something">something</see>, which works of course. But how do you reference a class or a method with generic types?
public class ...
Scrivens asked 10/2, 2009 at 12:50
1
Is it possible, that having a constant
public const string MyString = "myValue"
to get its value "myValue" in xml comments ? I'm interested in this for generating swagger docu...
Pelican asked 1/3, 2021 at 8:28
2
Solved
The following XML comment gives a compile time warning:
/// <summary>
/// Provides data for the <see cref="TextDraw.Click"/> event.
/// </summary>
public class TextDrawEventArgs ...
Yim asked 24/1, 2015 at 22:2
6
Solved
I am trying to generate partial XML documentation during my build process for a C# project in VS2012. When I check the XML documentation file option in Project->Properties->Build, I get a build war...
Hanser asked 13/6, 2013 at 13:25
5
Solved
The documentation for enabling XmlDoc integration into your Web Api projects appears to only handle situations where all of your API types are part of your WebApi project. In particular, it discuss...
Analphabetic asked 19/2, 2014 at 23:56
3
I added the <returns> xml tag to some of my methods but I can't see its content in IntelliSense.
Here is my code:
/// <summary>
/// we all live in a yellow summary
/// </summary>...
Gemmulation asked 17/3, 2010 at 16:39
1
Solved
Is it possible to document unit purpose in Delphi using <summary> XMLDoc tag? How?
I've tried put summary both before unit:
/// <summary> Unit purpose: test </summary>
unit Test...
Recuperator asked 14/11, 2019 at 10:52
3
We are using Swagger UI documentation to describe our project API. Swagger have to read XML from projectname.xml to show all the C.R.U.D. functions we have in project.
The problem is when I switch...
Outmoded asked 28/11, 2016 at 2:50
4
I am looking for an alternative to C#'s XML source code documentation which introduced by the very nature of XML a lot of noise that is heavy on the eye and more work to write:
/// <summary>...
Volsci asked 29/7, 2014 at 9:48
5
Solved
This should be waaaay easier...
I want to add a "coded" line break to the XML documentation in my code
/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the searc...
Mitten asked 2/9, 2011 at 4:2
7
Solved
I have always made a point of writing nice code comments for classes and methods with the C# xml syntax. I always expected to easily be able to export them later on.
Today I actually have to do so...
Ambrogio asked 9/9, 2008 at 12:53
2
Solved
Which C# XML documentation comment tag is used for the literals true, false and null?
In Microsoft's own documentation, these literals appear in bold text. For example, the documentation for...
Lamella asked 23/1, 2014 at 21:3
1
Solved
With ValueTuple in C# 7, it is now possible to write methods and properties that return or consume composite objects without explicitly declaring a type. These named tuples can however be potential...
Tello asked 6/5, 2018 at 9:47
2
Solved
What's the proper way to comment this?
/// <summary>
/// Initializes a new instance of the <see cref="Repository"/> class.
/// </summary>
/// <param name="unitOf...
Cabdriver asked 29/7, 2011 at 2:48
1 Next >
© 2022 - 2024 — McMap. All rights reserved.