Question

我正在使用Sandcastle构建API文档。代码有多个类和方法，标记为已弃用。现在我想在API文档输出中明确标记这些方法（划掉或其他标记）。但是，Sandcastle输出根本不标记过时的方法/类。

我的问题是。我需要做些什么才能让Sandcastle标记过时的方法/类。

感谢您的任何建议/帮助。

Answer 1

我发现了这个问题。问题是我已经使用的API和属性过滤器的混合。

所以我将System-namespace添加到我的API过滤器中，以便它包含Obsolete-Attribute：

<apiFilter>
  <namespace name="System" expose="true">
    <type name="ObsoleteAttribute" expose="true" />
    <type name="SerializableAttribute" expose="false" />
  </namespace>
  <!-- rest of the stuff -->
</apiFilter>

并将其添加到属性过滤器列表中：

<attributeFilter expose="true">
  <namespace name="System" expose="false">
    <type name="ObsoleteAttribute" expose="true" />
  </namespace>
  <!-- rest of the stuff -->
</attributeFilter>

我在属性过滤器中有'ObsoleteAttribute'，但在API过滤器中没有。

这个帖子也很有帮助：http://docproject.codeplex.com/discussions/74716?ProjectName=docproject

如何使用sandcastle标记输出中的过时类/方法

1 个答案: