Question

我正在记录c＃代码。我有这个接口，它暴露了Action<string>属性。

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帮助文件生成器来构建我的文档。我实际上遇到了你所做的完全相同的问题。 SHFB并不支持这一点，但我在那里有一个问题，我在那里谈论我个人如何将这些标签添加到他所做的输出中。基本上，您必须将标记添加到几个XML转换中，然后它将显示在您的文档中。

https://github.com/EWSoftware/SHFB

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

这是我打开的具体问题。然后，它会自动显示在我们的API文档中，并可用于包含我们使用的任何标记集。我们使用它的一个原因是数据类型，m，m / s，m ^ 3等。

Answer 2

根据您在评论中解释的内容，我会尝试给您一个答案......从属性代表的概念及其作用开始。根据该名称为您的财产命名。然后，使用MSDN网站（https://msdn.microsoft.com/en-us/library/5ast78ax.aspx）中的标记以您喜欢的格式提供解释。就个人而言，我只是在摘要块中放置一个简短的描述。记录属性时，您不希望过于扩展。 I.E。：“通常是一个字符串。如果为null，是否为XYZ”。

C＃文档字符串：Action属性的参数

2 个答案: