인터페이스 구현에 대한 문서를 복제 / 좋거나 나쁘게 무시합니까?

그래서 우리는 이와 같은 인터페이스를 가지고 있습니다

/// <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기능을 가진 다른 유사한 문서 복제가 있습니다.

이것이 나쁘거나 피해야합니까? 전혀 가치가 있습니까?

일반적으로, 구현에 대해 언급해야 할 특정 사항 이 있는 경우 구현 방법에 새 문서 만 추가 합니다.

javadoc에서는 다른 메소드에 링크 할 수 있으며, 인터페이스의 메소드 문서에 대한 구현에서 링크를 작성할 수 있습니다. 나는 이것이 .Net에서 수행되어야하는 방법이라고 생각합니다 (내 경험이 아닌 온라인 문서를 읽은 것에 근거를두고 있습니다).

/// <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();
}

/// <summary>
/// A Foo Creator which is fast
/// </summary>
public class FastFooCreator : ICreatesFoo
{
  /// <summary>
  /// <see cref="ICreatesFoo.Create(Foo)"/>
  /// </summary>
  public void Create(Foo foo)
  {
    //insert code here
  }
  /// <summary>
  /// <see cref="ICreatesFoo.Bar()"/>
  /// Also Note: Implementation of Bar() in FastFooCreator
  /// requires a minimum of 512 MB RAM to Bar the Foo. 
  /// </summary>
  public void Bar()
  {
    //code here
  }
}

<see/>요소에 대한 설명서 : http://msdn.microsoft.com/en-us/library/acd0tfbe.aspx