9
Sınıfları ve arayüzleri belgelemenin en iyi yolu nedir? IFoo adında bir arabirimden türeyen Foo adında somut bir sınıfınız varsa söyleyin. Yorumlarınızı yöntemleriniz için nereye koyarsınız? Yorumlarınızı hem arayüzde hem de somut sınıfta kopyaladınız mı? Genellikle ancak, aynı şeyi söyleme, hem koyuyorlarKod Yorumlama: Kod açıklamalarınızı Arayüzlere mi yoksa Beton sınıflarına mı yoksa her ikisine mi yazıyorsunuz?
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 ... ve GhostDoc kullanıyorsanız, arayüz üyelerinden somut uygulamalara kopyalanan arayüz yorumları almak kolaydır. – Groo