所以我们有一个像这样的界面
/// <summary>
/// Interface for classes capable of creating foos
/// </summary>
public interface ICreatesFoo
{
/// <summary>
/// Creates foos
/// </summary>
void Create(Foo foo);
/// <summary>
/// Does Bar stuff
/// </summary>
void Bar();
}
最近,我们播放了一个文档故事,涉及生成并确保像上面那样有大量XML文档。但是,这导致了很多重复的文档。示例实现:
/// <summary>
/// A Foo Creator which is fast
/// </summary>
public class FastFooCreator : ICreatesFoo
{
/// <summary>
/// Creates foos
/// </summary>
public void Create(Foo foo)
{
//insert code here
}
/// <summary>
/// Does Bar stuff
/// </summary>
public void Bar()
{
//code here
}
}
如您所见,方法文档是界面的直接内容。
最大的问题是,这是一件坏事吗?由于重复,我的直觉告诉我是,但是又可能不是吗?
另外,我们还有其他类似的override
功能和virtual
功能重复的文档。
这不好吗?应该避免吗?完全值得吗?
如果使用Resharper,则只能在实现中更改注释,然后使用“上拉成员”来更新界面。
—
vortexwolf 2013年
我这样做是因为,也许是因为我不太擅长使用外部工具,而是更喜欢去浏览接口的头文件以查看我可以对特定类型的事情进行处理(这是针对C和C ++的,源文件标题的概念)。它的确有些重复,但是我尝试寻找机会添加与覆盖该方法的具体类有关的更具体的细节,例如,我喜欢它,并且有一个强迫症,如果我不这样做,我会忽略一些重要的东西请参阅头文件中每个功能的注释。