Как я могу хранить комментарии XML для описания методов в отдельном файле?

Question

Этот вопрос вытекает из этого вопроса документация по коду, сколько это слишком много?

Один из ответов состоял в том, чтобы хранить документацию xml в отдельном файле. Мне очень понравился этот ответ, поскольку, когда я просматриваю код, многословность документации раздражает, с другой стороны, подробность полезна при поиске правильного метода с помощью intellisense или публикации документации.

Ответ состоял в том, чтобы использовать тег включения

/// <include file="Documentation/XML/YourClass.xml" path="//documentation/members[@name='YourClass']/*"/>

Существует также статья MSDN о теге включения здесь.

Я выяснил, как сохранить сводную информацию, но я не знаю, и я не смог найти, как поместить туда документацию по методам. (что важнее самой сводки классов.

Answer 1

Ответ прост. Прочитайте созданные XML-файлы. Они дают представление о том, как должны выглядеть разделенные XML-файлы.

Чтение полученных XML-файлов и описание метода (с параметрами и т. д.):

<member name="M:BitFactory.Logging.Logger.DoLog(BitFactory.Logging.LogEntry)">
    <summary>
    Really log aLogEntry. (We are past filtering at this point.)
    Subclasses might want to do something more interesting and override this method.
    </summary>
    <param name="aLogEntry">The LogEntry to log</param>
    <returns>true upon success, false upon failure.</returns>
</member>

T, M, F префиксы Тип, Метод, Поле.