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

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

1 голос
/ 04 марта 2009

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

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

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

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

Здесь также есть статья MSDN о теге include .

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

1 Ответ

1 голос
/ 09 марта 2009

Ответ прост. Прочитайте созданные 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 префиксы Тип, Метод, Поле.

...