Question

记录依赖项属性的最佳方法是什么？

我应该在字段上放置xml文档：

/// <summary>Documentation goes here</summary>
public static readonly DependencyProperty NameProperty = 
        DependencyProperty.Register(...)

或在物业上：

/// <summary>and/or here?</summary>
public string Name{ get{...} set{...} }

还是我真的需要记录（和维护）两者？

Answer 1

好的，这就是我想出来的。

我在依赖项属性中使用了一个特殊的xml标记，该标记将被xsl转换替换。没有它就可以这样做，但随后Visual Studio会发出警告，因为该字段似乎没有文档。

/// <dpdoc />
public static readonly DependencyProperty PositionProperty = 
    DependencyProperty.Register(...)

C＃属性照常记录，只要确保不要忘记值描述。

/// <summary>Gets or sets the position of this element</summary>
/// <value>Position (in pixel) relative to the parent's upper left corner.</value>
/// <remarks><para>
/// If either the <c>x</c> or <c>y</c> component is <c>+inf</c> this indicates...
/// </para></remarks>
public Point Position{ get{...} set{...} }

Visual Studio在构建期间根据这些注释创建一个xml文件。通过一些xsl转换，dpdoc节点将被属性文档的修改版本替换。生成的xml文件与我们很好地记录属性标识符相同。它甚至包括一个简短的说明，即有另一种访问变量的方法：

/// <summary>Position (in pixel) relative to the parent's upper left corner.</summary>
/// <remarks><para>
/// If either the <c>x</c> or <c>y</c> component is <c>+inf</c> this indicates...
/// <para>
/// This dependency property can be accessed via the <see cref="Position"/> property.
/// </para>
/// </para></remarks>
public static readonly DependencyProperty PositionProperty = 
    DependencyProperty.Register(...)

这样，两个API都有适当的文档，我们不需要在代码中复制文档。 xsl转换可以在构建后的事件中完成，也可以集成到文档生成过程中。

这是xsl：

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
    <xsl:template match="//dpdoc">
        <xsl:variable name="propertyName" select="concat('P:', substring(../@name,3,string-length(../@name)-10))" />
        <summary>
            <xsl:apply-templates select="//member[@name=$propertyName]/value/node()"/>
        </summary>
        <xsl:apply-templates select="//member[@name=$propertyName]/*[not(self::remarks)][not(self::summary)][not(self::value)]"/>
        <remarks>
            <xsl:apply-templates select="//member[@name=$propertyName]/remarks/node()"/>
            <para>
                This dependency property can be accessed via the
                <see>
                    <xsl:attribute name="cref"><xsl:value-of select="$propertyName"/></xsl:attribute>
                </see>
                property.
            </para>
        </remarks>
    </xsl:template>
    <xsl:template match="@*|node()">
        <xsl:copy>
            <xsl:apply-templates select="@*|node()"/>
        </xsl:copy>
    </xsl:template>
</xsl:stylesheet>

为什么我要这样：

属性标识符（DependencyProperty实例）和属性都是公共的，因此可以合法地用于访问属性。我们有两个API用于相同的逻辑变量。
代码文档应描述尚未查看的内容。在此上下文中，它应描述属性的含义及其值以及如何正确使用它。由于属性标识符和c＃属性都引用相同的逻辑变量，因此它们具有相同的含义。
用户可以自由选择两种方式中的一种来访问逻辑变量，并且不知道另一种。两者都必须妥善记录。
复制粘贴代码注释与复制粘贴代码一样糟糕。

Answer 2

您应该记录和维护两者。一个是依赖属性，另一个是常规属性，恰好被实现为访问该依赖属性。它们不是一回事，需要单独的文档。

依赖项属性的XML文档

2 个答案: