Где разместить комментарии XML-документации для прикрепленного свойства?
-
11-07-2019 - |
Вопрос
Предполагая, что у меня есть прикрепленное свойство, определенное следующим образом:
public static string GetMyProperty(DependencyObject obj)
{
return (string)obj.GetValue(MyPropertyProperty);
}
public static void SetMyProperty(DependencyObject obj, string value)
{
obj.SetValue(MyPropertyProperty, value);
}
// Using a DependencyProperty as the backing store for MyProperty. This enables animation, styling, binding, etc...
public static readonly DependencyProperty MyPropertyProperty =
DependencyProperty.RegisterAttached("MyProperty", typeof(string), typeof(MyClass), new UIPropertyMetadata(0));
Я могу написать документацию для идентификатора свойства (MyPropertyProperty
) и для средств доступа (GetMyProperty
и SetMyProperty
), но я понятия не имею, куда поместить документацию для Прикрепленное свойство MyClass.MyProperty, поскольку это не настоящий элемент кода.
Библиотека MSDN содержит такую документацию (см., например, Grid.Row
), так что это должно быть возможно...
Где мне следует поместить комментарии XML-документации для прикрепленного свойства?
Решение
Есть статья об этом для Сэндкасла.
Другие советы
Несмотря на то, что ответ немного запоздал, я нашел решение для появления документации во время выполнения Visual Studio.
Если вы используете ReSharper и нажимаете CTRLвопрос затем XML-документация, добавленная над SetXXX
-метод используется для отображения Quick-Documentation
.