C# 文档字符串 : Parameter of an Action property

Question

我现在正在记录 C# 代码。我有这个接口(interface)，它公开了一个 Action<string>属性(property)。

interface IFoo
{
    /// <summary>
    /// Will be called when Bar happens
    /// </summary>
    /// <action_parameter_1_or_something>
    /// Can be a string or null.
    /// If not null, the message must be displayed.
    /// If null, the message must be cleared.
    /// </action_parameter_1_or_something>
    Action<string> OnBarHappened { get; set; }
}

我想记录将提供给 Action 的参数.显然，我明智地命名标签，action_parameter_1_or_something不存在。

您将如何记录？

Answer 1

我使用 SandcaSTLe Help File Builder 来构建我的文档。我实际上遇到了与您完全相同的问题。 SHFB 一开始不支持这一点，但我在那里遇到了一个问题，我谈到了我如何亲自将这些标签添加到他所做的输出中。基本上，您必须将标签添加到几个 XML 转换中，然后它才会显示在您的文档中。

https://github.com/EWSoftware/SHFB

https://github.com/EWSoftware/SHFB/issues/199

那是我打开的具体问题。然后它会自动显示在我们的 API 文档中，并可用于包含我们使用的任何标签集。我们用它做的事情之一是数据类型、m、m/s、m^3 等。