XML Tags For Warnings/Important Comments When Documenting C# Code

Question

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 regarding the use a class or method etc?

Failing that, what is the best way of documenting a warning or important information in XML comments?

YungDeiza · Accepted Answer · 2023-03-03 15:53:56Z

2

It doesn't seem that there is any specific dedicated tag for doing this. In the few instances that I've needed to add warnings/important comments to methods, I used the remarks tag e.g.

/// <summary>
/// General info on the method
/// </summary>
/// <remarks>WARNING: Important information on the method</remarks>
public void Method()
{
    // Method content
}

answered Mar 3, 2023 at 15:53

YungDeiza

4,8242 gold badges18 silver badges44 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

XML Tags For Warnings/Important Comments When Documenting C# Code

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related