Как я документирую c# dll
Как я пишу класс так, чтобы свойство и описания метода были видимы людям, ссылающимся на 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 ответа
В Visual Studio:
Проект -> Свойства -> Сборка -> Отметьте «Файл документации XML».
Дополнительные сведения см. В Комментарии XML, позволяющие создавать документацию непосредственно из исходных файлов Visual Studio .NET .
Вы создали файл документации XML для своего второго случая?
Свойства проекта -> Сборка -> [Вывод] XML Файл документации
Описание приведено в DescriptionAttribute наверняка виден в Property Grid и не имеет ничего общего с редактором кода.
Чтобы комментарии XML были доступны, вы должны сгенерировать файл XML-документации и отправить его вместе со сборкой.
Второй должен работать (резюме), обязательно выберите в проекте Properties (Build -> Output) XML Documentation File.