¿Dónde colocar los comentarios de la documentación XML para una propiedad adjunta?
-
11-07-2019 - |
Pregunta
Suponiendo que tengo una propiedad adjunta definida así:
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));
Puedo escribir la documentación para el identificador de propiedad ( MyPropertyProperty
) y para los accesores ( GetMyProperty
y SetMyProperty
), pero no tengo idea de dónde colocar la documentación para propiedad adjunta MyClass.MyProperty , ya que no es un elemento de código real.
La biblioteca MSDN contiene dicha documentación (consulte, por ejemplo, Grid.Row
), por lo que debe ser posible ...
¿Dónde debo colocar los comentarios de documentación XML para una propiedad adjunta?
Solución
Hay un artículo sobre eso para Sandcastle.
Otros consejos
Aunque la respuesta es un poco tardía, he encontrado una solución para la aparición de la documentación durante el tiempo de ejecución de Visual Studio.
Si usa ReSharper y presiona CTRL Q , entonces la Documentación XML que se agrega sobre el método SetXXX
se usa para mostrar la Documentación rápida
.