在.NET项目(沙堡)命名空间的文件?(Namespace documentation on a .

2019-07-28 07:59发布

我开始使用沙堡前段时间为我们的项目之一的文档网站。 它的工作非常好,但我们一直只写文档,在我们的项目中的类,方法,属性(...),不得不对整个项目和项目部件/模块/命名空间完全独立的文档。 这将是很好,如果我能合并在一起的是文件和各自的文件添加到生成的辅助文件,但我无法弄清楚如何做到这一点。

只需添加注释命名空间的声明似乎并没有工作(C#):

/// <summary>
/// My short namespace description
/// </summary>
namespace MyNamespace { ... }

有谁知道如何做到这一点? 我知道这是可能在某种程度上,这将是非常好的有... :)

Answer 1:

沙堡还支持NDoc的风格命名的文件,它可以让你坚持在文档中的源文件:

只需创建一个名为NamespaceDoc在你想要记录的名称空间非公共类,并且该类的XML文档注释将被用于命名空间。

带有[编译器生成的]属性装饰,以防止类本身从显示的文档中的。

例:

namespace Some.Test
{
    /// <summary>
    /// The <see cref="Some.Test"/> namespace contains classes for ....
    /// </summary>

    [System.Runtime.CompilerServices.CompilerGenerated]
    class NamespaceDoc
    {
    }
}

在沙塔工作项目位于这里。



Answer 2:

如果您使用的沙堡帮助文件生成器有进入命名空间摘要的对话框。 (显然也定义一个特殊阶级的支持,但我不喜欢它。)

从功能列表:

那将出现在帮助文件项目总结和命名空间意见总结定义。 你也可以很容易地指出哪些命名空间包含或从帮助文件中排除。 支持还包括用于通过每个命名空间内的NamespaceDoc类指定的命名空间评论。



Answer 3:

使用沙堡帮助文件生成器 。 它允许指定在XML项目文件的命名空间的说明

例:

<namespaceSummaryItem name="System" isDocumented="True">
    Generic interfaces and helper classes.
</namespaceSummaryItem>

参考文献:

  • 例如开源项目与每一位构建生成的文件(所有脚本都在后备箱)。
  • 这是由SHFB的文件看起来像在Web上 (它部署在每一个被迫版本)



Answer 4:

我知道这是旧的文章,但是这可能是帮助别人。

下面这个链接 ,你可以设置命名空间的描述,而无需添加非公共类到您的项目中。

编辑命名空间摘要,扩大SHFB项目属性选项卡中的摘要部分。 你会看到一个名为“NamespaceSummaries”设置,最初显示的值,“(无)”。 点击设置,选择它,并显示一个省略号(...)会出现一个按钮。 单击此按钮可以显示命名空间摘要对话框,如下图所示:



Answer 5:

你不能添加引用这种方式 - 通过NamespaceDoc.cs情况下做到这一点

/// <summary> /// Concrete implementation of see cref="IInterface" using see cref="Concrete"
/// </summary> class NamespaceDoc { }

看这里



Answer 6:

我看到的文档“外部XML注释文件”。 显示一个模式,如:

<doc>
    <assembly/>
    <members>
        <member/>
    </members>
</doc>

如果这是放置在一个单独的文件,你会扩展为(XML / AML)和可以在此在Visual Studio项目中使用?



文章来源: Namespace documentation on a .Net project (Sandcastle)?