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

Я пытаюсь создать документацию для своего кода и использую для этого 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:... для интерфейса и так далее.


person Bildsoe    schedule 29.07.2011    source источник


Ответы (1)


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

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

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

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

person Christian.K    schedule 29.07.2011
comment
Спасибо! - Я думаю, что тогда я просто сделаю это вручную. Было бы реально сэкономить время, если бы это можно было сделать автоматически. - person Bildsoe; 29.07.2011