名字空间的文件上。净项目(沙城)?

Question

我开始使用 沙塔 前一段时间来生成文档网站，为我们的一个项目。它的工作很好，但我们总是只有书面文件的类别、方法、特性(...)在我们的项目和已经完全独立文件总体项目和项目部分/modules/名称空间。这将是很好如果我可以合并，文件一起，并增加各自的文件中产生的辅助文件，但我可以弄清楚如何做到这一点。

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

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

没有人知道如何做到这一点？我知道这很可能以某种方式，它将是非常不错的...:)

Answer 1

Sandcastle还支持ndoc样式的命名空间文档，它允许您将文档粘贴在源文件中：

只需在要记录的命名空间中创建一个名为NamespaceDoc的非公共类，该类的xml doc注释将用于命名空间。

用[CompilerGenerated]属性装饰它以防止类本身出现在文档中。

示例：

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

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

SandCastle中的工作项位于 此处。

Answer 2

如果您使用 Sandcastle帮助文件构建器，则会出现一个对话框，用于输入命名空间摘要。 （显然也支持定义一个特定的类，但我不喜欢它。）

从功能列表中：

  

项目摘要和定义   命名空间摘要注释   出现在帮助文件中。你也可以   轻松指出要使用的命名空间   包含或排除在帮助文件中。   还包括支持   通过a指定命名空间注释   每个NamespaceDoc类   命名空间。

Answer 3

使用 Sandcastle帮助的文件生成器.它允许指定名称空间说明在XML项目的文件

例如：

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

参考文献：

• 例的开放源码项目 生成文档 每一个建设(所有的剧本都在 干线).
• 那是 如何通过的文件 SHFB看起来像上网 (它 是部署在每一个强制建立)

.

Answer 4

我知道这是一个老帖子，但这可能对其他人有帮助。

点击此链接，您可以在不需要的情况下设置名称空间的描述将非公共类添加到项目中。

  

要编辑命名空间摘要，请展开SHFB中“项目属性”选项卡中的“摘要”部分。您将看到名为<！> quot; 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项目中使用它？