省略特定属性

时间:2013-04-16 19:48:56

标签: c# visual-studio documentation

在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。如果这在过去的一年中向前发展会很好,但我没有希望。

1 个答案:

答案 0 :(得分:0)

假设你有一个属性说

public string val { get; set; }

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

&#34; 缺少公开可见类型或成员的XML评论&#34;

右键单击错误列表中的警告,然后选择显示错误帮助。它显示了一个网页,其中包含&#34;编译器警告(级别4)CS 1591 &#34;

使用上面获得的警告编号以及要从文档中省略的属性周围的C#预处理程序指令#pragma warning,如下所示。

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