我想我們都(當我們可以被打擾的時候!)評論我們的接口。例如評論界面,實施還是兩者?
/// <summary>
/// Foo Interface
/// </summary>
public interface Foo
{
/// <summary>
/// Will 'bar'
/// </summary>
/// <param name="wibble">Wibble factor</param>
void Bar(string wibble);
}
您是否也評論實施(也可能提供給客戶,例如作爲圖書館的一部分)?如果是的話,你如何管理保持兩者同步?或者你只是添加一個'看文檔的界面'評論?
感謝
很感謝我對@inheritDoc標記不知道的信息 – 2009-04-17 10:17:17
哇......我不知道{@inheritDoc}是否存在!我將從今天起定期使用它。 – mcherm 2010-07-02 17:07:46