Hepsi (rahatsız olabilir!) biz hayal ediyorum bizim arabirimleri yorum. örneğin

/// <summary>
/// Foo Interface
/// </summary>
public interface Foo
{
    /// <summary>
    /// Will 'bar'
    /// </summary>
    /// <param name="wibble">Wibble factor</param>
    void Bar(string wibble);
}

Ayrıca uygulama da, örneğin bir kütüphanenin bir parçası olarak müşterilere sunulan olabilir) bir yorum yapar mısın? Nasıl senkronize iki tutmak geçiniyorsunuz? Yoksa sadece bir 'belgeleme' yorum? arabirimi Görmek ekleyin

Teşekkürler

Genel bir kural olarak, kodu ile (Kendini Tekrar Etme) Aynı KURU prensibi kullanın:

• arabirim, arayüz belge
• uygulama, Uygulama Detayları belge

Java özel: uygulama belgeleme, kullanma {@inheritDoc} "" javadocs arabirimi. eklemek etiketi

Daha fazla bilgi için:

• Official javadoc documentation
• Bazı resmi olmayan 3**.