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

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

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

Ответы [ 2 ]

6 голосов
/ 04 августа 2009

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

1 голос
/ 23 февраля 2016

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

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

...