9
클래스 및 인터페이스를 문서화하는 가장 좋은 방법은 무엇입니까? IFoo라는 인터페이스에서 파생 된 Foo라는 구체적인 클래스가 있다고 가정 해보십시오. 당신은 당신의 방법에 대한 당신의 의견을 어디에 두 었는가? 구체적인 클래스뿐만 아니라 인터페이스에 대한 귀하의 의견을 복제합니까? 나는 일반적으로하지만, 그들은 같은 말을하지 않는, 모두 넣어코드 주석 처리 : 코드 주석을 Interfaces 또는 Concrete 클래스 중 하나 또는 둘 다에 배치합니까?
public class Foo : IFoo
{
/// <summary>
/// This function does something
/// </summary>
public void DoSomething()
{
}
}
public interface IFoo
{
/// <summary>
/// This function does something
/// </summary>
void DoSomething();
}
+1 ... 그리고 GhostDoc을 사용하는 경우 인터페이스 구성원이 해당 구현에 복사 한 인터페이스 주석을 쉽게 얻을 수 있습니다. – Groo