Stylecop不理解<inheritdoc> </inheritdoc>

时间:2012-06-14 20:07:51

标签: c# documentation stylecop inheritdoc

我正在尝试使用Stylecop 4.7.31 我有一个项目,其中声明了一个接口:

public interface IRmlManager
{
    /// <summary>
    /// Adds the notification.
    /// </summary>
    /// <param name="notificationData">The notification data.</param>
    void AddNotification(RmlNotificationData notificationData);
}

和另一个项目,其中一个接口的实现:

public class RmlManager : IRmlManager
{
........
    /// ???
    void AddNotification(RmlNotificationData notificationData);
........
}

如果我使用<inheritdoc />而不是???,Stylecop会忽略它并产生错误:

BusinessLogic\RmlManager.cs(39,1): error : SA1604: The documentation header must have a summary tag.
BusinessLogic\RmlManager.cs(39,1): error : SA1611: The documentation header must contain param tags matching the element's parameter list.

有什么想法我做错了吗? 根据谷歌的说法,Stylecop大约从4.1版开始支持这个标签

1 个答案:

答案 0 :(得分:0)

我讨厌告诉你,但是根据http://stylecop.codeplex.com/workitem/6637,StyleCop支持Inheritdoc。

所以,这只能被认为是一个特定的实例(即它确实是undrestand inheritdoc,只是这个特定的例子是一个bug行为)。

鉴于inheritdoc被普遍接受,我建议你在一个stylecop特定列表上询问(在http://stylecop.codeplex.com/discussions上在codeplax上打开他们网站上的讨论)并可能制作一个repro案例并打开一个bug。