9
Thực hành tốt nhất trong các lớp học và giao diện tài liệu là gì. Giả sử bạn có một lớp cụ thể gọi là Foo, nó xuất phát từ một giao diện có tên là IFoo. Bạn đặt nhận xét của mình cho phương pháp của mình ở đâu? Bạn có nhân đôi ý kiến của mình trên Giao diện cũng như lớp bê tông không?Mã nhận xét: Bạn có đặt nhận xét mã của bạn trên Giao diện hoặc trên các lớp Bê tông hoặc cả hai?
Dưới đây là một ví dụ trong đó ý kiến được nhân đôi:
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 ... và nếu bạn đang sử dụng GhostDoc, bạn có thể dễ dàng nhận các nhận xét giao diện được sao chép từ các thành viên giao diện đến triển khai cụ thể của chúng. – Groo