.Net отражение, чтобы получить описание класса / свойства и т.д?

Question

Я знаю, это маловероятно, но мне было интересно, есть ли способ получить комментарии (то есть биты после '' ') класса или свойства ..? Мне удалось получить список свойств класса с помощью класса PropertyInfo, но я не могу найти способ получить комментарии / описание. Мне это нужно для руководства, которое я пишу для администраторов моего сайта - было бы здорово если он может автоматически обновляться, если добавляются новые свойства, то нет необходимости слишком много беспокоиться об его обновлении в будущем. Кто-нибудь знает, как это сделать? Заранее спасибо.

С уважением,

Richard

Answer 1

Вы можете использовать атрибуты свойства для украшения свойств и использовать отражение для чтения данных в атрибутах:

[Description('This is my property description')]
public String MyStringProp { get; set; }

Затем используйте

FieldInfo.GetCustomAttributes

, чтобы прочитать описание.

Answer 2

Я думаю, вы говорите о комментариях XML, верно?

В этом случае есть некоторые сторонние инструменты для преобразования их в различные форматы, включая скомпилированные файлы справки и веб-сайты в стиле MSDN.

Джон Скит только что опубликовал блог об этой неделе:
http://msmvps.com/blogs/jon_skeet/archive/2010/04/10/documentation-with-sandcastle-a-notebook.aspx

Answer 3

После того, как класс скомпилирован, комментарии к документам давно исчезли. Если вы скомпилируете с ключом / doc , вы получите вместе с ним XML-файл, который вы можете использовать.

Answer 4

Вы не можете получить доступ к обычным комментариям через отражение.
Однако, если вы используете xml-comments (я думаю, что это в VB '' '), может быть создан файл документации (в моемПроект C # в свойствах проекта -> build -> выходной путь / файл документации xml), к которому вы можете получить доступ.Но для этого вам не нужно размышлять.

Здесь и здесь - некоторые описания XML-комментариев в VBasic.

Answer 5

Нет, вы не можете сделать это с помощью отражения.

Что вы можете сделать, это настроить Visual Studio (или любой другой процесс сборки, который вы используете) для создания XML-файла во время сборки, содержащего комментарии, которые вы затем можете распространять.