如何在Sandcastle帮助文件中包含自定义文档注释元素? [英] How to include custom doc-comment elements in Sandcastle Help File?

问题描述

在C#中，如果我有添加XML文档的方法，则默认情况下将生成以下内容:

In C# if I have a method that I add XML documenting, the following will be generated by default:

/// <summary>
/// Does something
/// </summary>
public string SomeValue { get; set; }

我想在下面添加我自己的文档注释，这在VS.NET构建中就可以了:

I want to add my own doc-comment as follows below which is just fine in VS.NET build:

/// <summary>
/// 
/// </summary>
/// <usage>Required</usage>
public string SomeValue { get; set; }

问题是我在输出.chm文件中看不到新的<usage>注释值.我刚开始使用Sandcastle，所以可能很容易错过，但我没有在文档中找到想要的东西.

The problem is I do not see the new <usage> comment values displayed on my output .chm file. I'm pretty new to using Sandcastle so it might be something easy I'm missing, but I didn't see what I was looking for in the documentation.

有人知道如何将<usage>值合并到我的输出帮助文件中吗?

Does anyone know how to incorporate the <usage> value in my output help file?

推荐答案

Supporting Custom tags in Sandcastle is an old article, but might still be relevant or at least point you in the right direction.

这篇关于如何在Sandcastle帮助文件中包含自定义文档注释元素?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！