Как мне документировать c # dll - PullRequest
8 голосов
/ 03 февраля 2010

Как мне написать класс, чтобы описания свойств и методов были видны людям, ссылающимся на dll в других проектах?

    [Description("My age in years attribute")]
    public int Age
    {
        get { return 0; }
        set { }
    }

не работает и

не работает
    /// <summary>
    /// My age in years attribute
    /// </summary>
    public int Age
    {
        get { return 0; }
        set { }
    }

Ответы [ 4 ]

14 голосов
/ 03 февраля 2010

В Visual Studio:

Проект -> Свойства -> Сборка -> Проверить «Файл документации XML».

Подробнее см. Комментарии XML, позволяющие создавать документацию непосредственно из исходных файлов Visual Studio .NET .

1 голос
/ 03 февраля 2010

Второй должен работать (резюме), обязательно выберите в проекте Свойства (Сборка -> Вывод) XML-файла документации.

1 голос
/ 03 февраля 2010

Вы построили XML documentation file для второго случая?

Свойства проекта -> Сборка -> [Выходные данные] Файл XML-документации

1 голос
/ 03 февраля 2010

Описание, приведенное в DescriptionAttribute, наверняка отображается в Property Grid и не имеет ничего общего с редактором кода.

Чтобы комментарии XML были доступны, вам необходимо создать файл документации XML и отправить его вместе со своей сборкой.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...