记录 C# 代码时用于警告/重要注释的 XML 标记

问题描述 投票:0回答:1

是否有任何官方 C# 文档(并由 IntelliSense 识别)识别的任何 xml 标记专门用于作为警告或有关使用类或方法等的非常重要信息的内容?

否则,在 XML 注释中记录警告或重要信息的最佳方式是什么?

c# xml-documentation
1个回答
0
投票

似乎没有任何特定的专用标签可以做到这一点。在我需要向方法添加警告/重要注释的少数情况下,我使用了

remarks
标签,例如

/// <summary>
/// General info on the method
/// </summary>
/// <remarks>WARNING: Important information on the method</remarks>
public void Method()
{
    // Method content
}
© www.soinside.com 2019 - 2024. All rights reserved.