Можно ли заставить VS указывать тип типа при создании xml-комментариев?

Question

Я пытаюсь создать документацию для своего кода и использую для этого xml-комментарии.Когда класс документируется следующим образом:

/// <summary>
/// Main presentation window
/// </summary>
public partial class mainWindow : Form
{
}

Файл xml будет содержать следующую запись для mainWindow:

<member name="T:CaseManager.mainWindow">
        <summary>
        Main presentation window
        </summary>
    </member>

T в T: CaseManager.mainWindow говорит мне, что«тип: класс, интерфейс, структура, перечисление, делегат», а остальное говорит мне пространство имен и имя типа.В любом случае, я могу указать, какой это тип.Например, написав T: C: ... для класса, T: I: ... для интерфейса и т. Д.

Answer 1

Согласно MSDN , по крайней мере компилятор не создает что-то еще или более конкретное.

Кроме того, даже если вам как-то удастся указать эти префиксы в ваших комментариях / исходном коде XML (вы можете в некоторых местах, например, при ссылке на другие вещи, например <see cref="T:SomeType"/>), компилятор ReSharper, а что нетбудет жаловаться на префиксы, отличные от поддерживаемых.

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

Итак, если не писать собственный набор инструментовдля извлечения комментариев и создания документации из этого, кажется, нет способа сделать то, что вы просите.Если это вообще приемлемо, вы можете проверить doxygen , однако я не знаю, на что он способен в этом отношении.