If a class implements a method defined in an interface you can choose whether you duplicate the documentation or reference it with <see cref="..." />
.
public interface IPerformer
{
/// <summary>
/// Do something useful.
/// </summary>
/// <param name="something">Object to do something with</param>
void Do(Something something);
}
public class Implementation : IPerformer
{
/// <copy from="IPerformer" /> # that is what I want!
public void Do(Something something)
{
// implementation ...
}
}
Is it possible to let the API documentation tool (Sandcastle) copy the documentation automatically (what would make reading the API documentation more comfortable)? Something like @inheritDoc
from Java Doc?
Sandcastle Help File Builder (SHFB) provide this functionality through the inheritdoc tag.