документирующие комментарии vs. атрибуты вроде Description
От: sergunok  
Дата: 08.11.10 14:59
Оценка:
Что лучше использовать (одно, другое, оба) для генерации красивых доков и одновременно подсветке комментария в VS?
Re: документирующие комментарии vs. атрибуты вроде Descripti
От: _FRED_ Черногория
Дата: 08.11.10 15:14
Оценка: 2 (1)
Здравствуйте, sergunok, Вы писали:

S>Что лучше использовать (одно, другое, оба) для генерации красивых доков и одновременно подсветке комментария в VS?


Для приведённых целей атрибуты не нужны.
Help will always be given at Hogwarts to those who ask for it.
Re[2]: документирующие комментарии vs. атрибуты вроде Descri
От: sergunok  
Дата: 08.11.10 15:58
Оценка:
Здравствуйте, _FRED_, Вы писали:

_FR>Здравствуйте, sergunok, Вы писали:


S>>Что лучше использовать (одно, другое, оба) для генерации красивых доков и одновременно подсветке комментария в VS?


_FR>Для приведённых целей атрибуты не нужны.


Спасибо!

Для каких целей кстати атрибуты могут пригодиться?
Re: документирующие комментарии vs. атрибуты вроде Descripti
От: MozgC США http://nightcoder.livejournal.com
Дата: 08.11.10 16:02
Оценка: +1
Здравствуйте, sergunok, Вы писали:

S>Что лучше использовать (одно, другое, оба) для генерации красивых доков и одновременно подсветке комментария в VS?


Я часто вместо комментария пишу xmldoc — во-первых, потом подсказки вылезают в intellisense, во-вторых, можно будет потом документацию сгенерировать, если потребуется.
Re[3]: документирующие комментарии vs. атрибуты вроде Descri
От: _FRED_ Черногория
Дата: 08.11.10 16:05
Оценка:
Здравствуйте, sergunok, Вы писали:

S>>>Что лучше использовать (одно, другое, оба) для генерации красивых доков и одновременно подсветке комментария в VS?

_FR>>Для приведённых целей атрибуты не нужны.
S>Спасибо!
S>Для каких целей кстати атрибуты могут пригодиться?

Атрибуты — для добавления метаинформации.

Коменты в некотором роде тоже метаинформация, но "для генерации красивых доков и одновременно подсветке комментария в VS" есть более специализированное средство, позволяющее более универсально описывать необходимое. Поэтому и пользоваться предподчтительно этим самым средством.
Help will always be given at Hogwarts to those who ask for it.
Re[3]: документирующие комментарии vs. атрибуты вроде Descri
От: MozgC США http://nightcoder.livejournal.com
Дата: 08.11.10 16:06
Оценка:
Здравствуйте, sergunok, Вы писали:

S>Для каких целей кстати атрибуты могут пригодиться?


Атрибуты (C# и Visual Basic)
Re[4]: документирующие комментарии vs. атрибуты вроде Descri
От: sergunok  
Дата: 08.11.10 19:07
Оценка:
Здравствуйте, MozgC, Вы писали:

MC>Здравствуйте, sergunok, Вы писали:


S>>Для каких целей кстати атрибуты могут пригодиться?


MC>Атрибуты (C# и Visual Basic)


Спасибо! Про предназначение атрибутов как таковых понятно..
Интересно, какие средства обрабатывают "описательные" атрибуты из ComponentModel: DescriptionAttribute, CategoryAttribute и т.п.
Re[5]: документирующие комментарии vs. атрибуты вроде Descri
От: MozgC США http://nightcoder.livejournal.com
Дата: 08.11.10 19:27
Оценка: 2 (1)
Здравствуйте, sergunok, Вы писали:

S>Спасибо! Про предназначение атрибутов как таковых понятно..

S>Интересно, какие средства обрабатывают "описательные" атрибуты из ComponentModel: DescriptionAttribute, CategoryAttribute и т.п.

В основном эти атрибуты используются для отображения информации о свойстве или событии в окне Properties (или любом другом PropertyGrid'е). В MSDN так и написано:

DescriptionAttribute — класс

Визуальный конструктор может отображать заданное описание при обращении к составляющим класс членам, как в окне "Свойства".


CategoryAttribute — класс

Задает имя категории, в которой при отображении в элементе управления PropertyGrid для группировки свойств или событий установлен режим "По категориям".
Атрибут CategoryAttribute показывает категорию, связываемую со свойством или событием, при перечислении свойств или событий в элементе управления PropertyGrid с режимом Categorized. Если атрибут CategoryAttribute не был применен к свойству или событию, элемент PropertyGrid связывает его с категорией Прочие. Для атрибута CategoryAttribute путем задания имени категории в конструкторе может быть создана новая категория с любым именем.


Но в целом эти атрибуты может читать кто захочет. Например, можно добавить атрибут Description к членам перечисления:

enum ShipmentType
{
  [Description("Delivery by airfreight")]
  Avia,
  [Description("Delivery through Europe")]
  Europe,
  [Description("Delivery by container")]
  Container,
}

И написать специальный helper, который будет добавлять в ComboBox элементы данного перечисления таким образом, что в ComboBox будет отображаться соответствующий текст из Description.
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.