您应该为Interfaces,具体实现或两者编写XML注释吗？

Question

标题基本概括了所有内容.我在哪里应用我的XML注释？我应该在界面中添加更通用的XML注释,并在实现类中添加更具描述性的注释吗？像这样:

public interface IObjectRepository
{
    /// <summary>
    ///    Returns an object from the respository that contains the specified ID.
    /// </summary>
    Object GetObject(int Id);
}

public ObjectRepository : IObjectRepository
{
    /// <summary>
    ///    Retrieves an object from the database that contains the specified ID.
    /// </summary>
    public Object GetObject(int Id)
    {
        Object myData = // Get from DB code.
        return myData;
    }
}

<param>为简单起见,我没有包括在内.

这是一个很好的评论做法还是有不同的方式？我是否只是跳过评论界面？任何帮助表示赞赏.

Answer 1

您可以在单独的文件中定义注释,然后使用<include>标记(请参阅MSDN).这样,您只需编写一次注释,但可以将其作为文档包含在多个不同的位置(例如,声明和接口的实现).

当然,这需要更多的纪律,因为它更难写.它也没那么有用,因为你不会在源代码中看到它们.但是,如果要使用XML注释来构建文档,那么这可能是一种很好的方法.