c# - 评论接口(interface)、实现还是两者兼而有之？

Question

我想我们所有人(当我们被打扰时!)评论我们的界面。例如

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

您是否还评论了实现(也可以提供给客户，例如作为库的一部分)？如果是这样，您如何管理使两者保持同步？还是您只是添加“查看文档界面”评论？

谢谢

Answer 1

作为一般规则，我使用与代码相同的 DRY(不要重复自己)原则:

• 关于接口(interface)，记录接口(interface)
• 关于实现，记录实现细节

Java 特定:在记录实现时，使用 {@inheritDoc} 标签从接口(interface)中“包含”javadocs。

更多信息:

• Official javadoc documentation
• 一些非官方的advice .