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

发布于 2024-10-16 14:11:18 字数 184 浏览 3 评论 0原文

我正在使用 Sandcastle 构建 API 文档。该代码有多个已标记为已弃用的类和方法。现在我希望在 API 文档输出中清楚地标记这些方法（划掉或其他标记）。然而，Sandcastle 输出根本不标记过时的方法/类。

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

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

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

从此见与不见 2024-10-23 14:11:18

好吧，我发现了这个问题。问题是我现有的 API 和属性过滤器的混合。

因此，我将系统命名空间添加到我的 API 过滤器中，以便它包含过时属性：

<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

Well I found the issue. The issue is a mix of the API and Attribute filters I had in place.

So I added the System-namespace to my API filters, so that it includes the Obsolete-Attribute:

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

And added it also to the list of Attribute-Filters:

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

I had the 'ObsoleteAttribute' in my attribute-filter, but not in the API-filter.

This thread was also helpful: http://docproject.codeplex.com/discussions/74716?ProjectName=docproject

回复收藏 0 原文

~没有更多了~