c# - 省略特定属性

Question

在 Visual Studio 中，有没有办法装饰特定属性以将它们从 C# 项目生成的默认 xml 文档中排除？

举个例子：

/// <summary>
/// This enables the external interface
/// </summary>
public string EnableExternalInferface { get; set; }

/// <summary>
/// This should not be publicly visible
/// </summary>
public bool SecretFeatureSwitch { get; set; }

理想的方法是用一些属性来装饰它。

经过额外的研究，我发现了以下问题，Hiding Classes/Methods From XML Documentation。如果这在过去的一年中有所进展，那就太好了，但我不抱希望。

Answer 1

假设你有一个属性说

public string val { get; set; }

启用 XML 文档后，您应该会看到以下警告

“缺少公开可见类型或成员的 XML 注释”

右键单击错误列表中的警告并选择显示错误帮助。它显示了一个网页，其中包含有关“编译器警告（级别 4）CS 1591 ”的信息

使用上面获得的警告编号以及 C# Preprocessor Directive #pragma 警告您要从文档中省略的属性，如下所示。

#pragma warning disable 1591
public string val { get; set; }
#pragma warning restore 1591