我们向外部客户提供了许多程序集,但并非所有公共(public) API 都得到官方支持。例如,由于并非最佳设计选择,有时必须从程序集中公开公开一个类型,我们的其余代码才能正常工作,但我们不希望客户使用该类型。传达缺乏支持的一部分是不以 XML 注释的形式提供任何智能感知。
有没有办法选择性地抑制 XML 注释?我正在寻找除了忽略警告 1591 之外的其他东西,因为这是一个长期维护问题。
示例:我有一个包含公共(public)类 A 和 B 的程序集。A 是官方支持的,应该有 XML 文档。 B 不适合外部使用,不应记录在案。我可以打开 XML 文档然后取消警告 1591。但是当我稍后添加官方支持的 C 类时,我希望编译器告诉我我搞砸了并且未能添加 XML 文档。如果我在项目级别抑制了 1591,就不会发生这种情况。我想我可以 #pragma 跨越整个类(class),但似乎应该有更好的方法来做到这一点。
最佳答案
将此类方法设为内部
,并将[assembly: InternalsVisibleTo("AssemblyName")]
属性添加到公开它们的程序集中。
关于c# - 在 C# 中有选择地抑制 XML 代码注释?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/2474372/