Где размещать комментарии XML-документации для прикрепленного свойства?

Предполагая, что у меня есть прикрепленное свойство, определенное следующим образом:

    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-документации для прикрепленного свойства?


person Thomas Levesque    schedule 03.08.2009    source источник


Ответы (2)


Об этом для Sandcastle есть статья.

person Kenan E. K.    schedule 03.08.2009
comment
Ответ только по ссылке с неработающей ссылкой. - person wondra; 11.12.2019

Несмотря на то, что ответ немного запоздал, я нашел решение для появления документации во время выполнения Visual Studio.

Если вы используете ReSharper и нажимаете CTRLQ, XML-документация, добавленная над методом SetXXX, используется для отображения Quick-Documentation.

person Michael Mairegger    schedule 23.02.2016