Question

实际上在我的开源项目中，我有成千上万的文档行

例如

/// <summary>
/// Gets or sets a value indicating whether the user can use the dialog box to define custom colors.
/// </summary>
/// <returns>true if the user can define custom colors; otherwise, false. The default is true.</returns>
[DefaultValue(true)]
public bool AllowFullOpen { get; set; }

以及更多部分内容。所以我认为，使用include到xml文件可以防止这种情况，每个属性或方法只有一行。

现在看起来像

/// <include file='../Documentation/Services/ColorPickerViewModel.xml' path='Docu/Object[@name="ColorPickerViewModel"]/Properties/Property[@name="AllowFullOpen"]/*'/>
[DefaultValue(true)]
public bool AllowFullOpen { get; set; }

但它对我来说仍然太长。所以我想，是否有包含文档行的最佳实践？

对我来说很重要的是，我在生产代码和xml文件中的行数较少，可以包含多个对象。

（是否还包含许可标题文本的可能性？我实际上有一个我在每个文件的某个区域中包含的片段）

Answer 1

我现在用工具制作它。我原来的来源已经没有评论了

public string Description { get; set; }

我有一个工具可以读取＆＃34;文档＆＃34; xml文件，这将注释放在

中

<Docu>
    <File name="DW.SharpTools\Services\BrowseFolderViewModel.cs">
        <Item>
            <Compare kind="Contains">string Description</Compare>
            <Documentation>
                <![CDATA[
                /// <summary>
                /// Gets or sets the descriptive text displayed above the tree view control in the dialog box.
                /// </summary>
                /// <returns>The description to display. The default is an empty string ("").</returns>
                [DefaultValue("")]
                ]]>
            </Documentation>
        </Item>

我通常编程
签入所有更改
我让工具运行，将文档代码放在
如果需要，我会在代码和documentation.xml中进行文档调整
我构建了发布（并注意警告）
我撤消所有文件更改

那么我没有100个而不是600行代码的文件^^

在代码中创建没有注释的文档XML

1 个答案: