Как скопировать документацию по .NET API?

Question

Если класс реализует метод, определенный в интерфейсе, вы можете выбрать, дублировать ли документацию или ссылаться на нее с помощью <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 ...
    }
}

Можно ли позволить инструменту документации API ( Sandcastle ) автоматически копировать документацию (что сделает чтение документации API более удобным)? Что-то вроде @inheritDoc из Java Doc?

Answer 1

Не совсем тот ответ, который вы ищете, но GhostDoc может сделать это за вас.Это будет тянуть комментарии из интерфейса в реализацию.

Answer 2

Построитель файлов справки Sandcastle (SHFB) предоставляет эту функцию с помощью тега inheritdoc .

Answer 3

Jetbrain Resharper позволяет вам копировать комментарии из интерфейса (или когда вы создаете экземпляр из интерфейса, он автоматически копирует их для вас), но если вы обновите комментарий интерфейса, вам придется удалить комментарии и снова скопировать комментарии из базы!

Answer 4

Документация AtomineerUtils Pro автоматически продублирует для вас документацию базового класса, интерфейса и перегрузки.(Это похоже на GhostDoc, но это гораздо более мощный и настраиваемый генератор документации).