c# - SandcaSTLe 没有记录属性摘要

标签 c# documentation sandcastle

我今天第一次将 SandCaSTLe 与 HelpBuilder GUI 结合使用,以帮助创建一些我们公开的函数和属性的 API。我包括了/// <summary> ... </summary我认为一些属性会从额外的文档或使用示例中受益。

当我将输出文件构建到 chm 时,我根本看不到摘要描述。列出了所有属性成员,但它们的描述是空白的。我重建了项目,并在 SandCaSTLe 中尝试了一些不同的设置,但它们仍然没有出现。

我忽略了一些明显的东西吗? SandCaSTLe 不读取属性摘要吗?还是摘要需要不同的关键字?

最佳答案

您必须告诉 Visual Studio 在编译时生成 XML 文档文件:只需按照此处所述设置相应的项目属性: http://msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0(v=vs.100).aspx

之后,SandcaSTLe会在“描述”栏中输出“摘要”注释。

关于c# - SandcaSTLe 没有记录属性摘要,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/10938977/

相关文章:

c# - 如何以编程方式设置新 SPListItem 的名称?

c# - 等待时发生 StaleElementReferenceException

c# - 如何为 DataGridView 设置标题

visual-studio - 将 VS2008 中的类图添加到 SandcaSTLe 帮助文件

sandcaSTLe - 网站输出中是否支持项目摘要?

.net - 我们可以加快沙箱速度吗?

c# - 如何在 ASP.NET MVC 4 中使用 Ninject 从 Web.config 绑定(bind)设置?

css - React 生成的文档(.md 文件)并将自定义样式传递给组件内的元素

documentation - 在 Kotlin 中记录函数参数的参数

javascript - 记录 sub/pub 的好方法是什么?