57

名前空間のxml-docを作成しますか？はいの場合、どのように、どこで？

可能であれば、次のようなほとんど空のファイルだと思います。

/// <summary>
/// This namespace contains stuff
/// </summary>
namespace Some.Namespace
{

}

しかし、それは機能しますか？あなたが...「宣言」するか、少なくとも他のすべてのファイルでも名前空間を使用するので...そして同じ名前空間のどこかにxml-documentationを書いたらどうなるでしょうか？1つはなくなったでしょうか？それとも、どういうわけかマージされますか？

4

7 に答える 7

36

NDocはNamespaceDoc、各名前空間にある特別なクラスを認識し、そこからのドキュメントを使用することで、これをサポートします。私はそれを試していませんが、サンドキャッスルは同じトリックをサポートしているようです。

編集： 例：

namespace Some.Namespace
{
    /// <summary>
    /// This namespace contains stuff
    /// </summary>
    public static class NamespaceDoc
    {
    }
}
于 2009-04-27T12:13:58.963 に答える
28

SandcastleはNamespaceDocを直接サポートしていませんが、Sandcastle Help File Builderを使用する場合は、Timが言及したNamespaceDocクラスを使用できます。

namespace Example
{
    /// <summary>
    ///   <para>
    ///     Summary
    ///   </para>
    /// </summary>
    /// <include file='_Namespace.xml' path='Documentation/*' />
    internal class NamespaceDoc
    {
    }
}

SCHBは構文をわずかに拡張し、コードファイルから直接コード例を埋め込むこともできます。_Namespace.xmlの例：

<?xml version="1.0" encoding="utf-8" ?>
<Documentation>
  <summary>
    <h1 class="heading">Example Namespace</h1>
    <para>
      This namespace is used in the following way:
    </para>

    <code source="Examples\Class.cs" lang="cs"></code>
    <code source="Examples\Class.vb" lang="vbnet"></code>

    <para>
      Hopefully this helps!
    </para>
  </summary>
</Documentation>

XMLファイルにドキュメントを含めると、コードに短い要約を記述し、ヘルプファイル用に別のXMLファイルに大きな説明を書き込むことができます。このようにして、コードがすべての詳細で乱雑になることはなく、簡単に読みやすくなります。

于 2009-04-27T12:27:53.280 に答える
18

Sandcastle Help File Builderは、名前空間に関するコメントをサポートしています。Sandcastleプロジェクトを開きます。Project Propertiesウィンドウで、ボタンに移動してSummariesクリックしEdit Namespace Summariesます。

ここに画像の説明を入力してください

于 2014-09-12T16:19:37.547 に答える
2

Sandcastleとその「ヘルプファイルビルダー」を使用する場合は、プロジェクトで次のコードを使用して名前空間と名前空間グループを文書化できます。

namespace Company.Product.Widgets
{
    /// <summary>
    /// These are the namespace comments for <c>Company.Product.Widgets</c>.
    /// </summary>
    [System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
    class NamespaceDoc
    {
    }
}

プロジェクトで名前空間のグループ化が有効になっている場合は、同様の方法でNamespaceGroupDocクラスを使用して名前空間グループのコメントを維持することもできます。次に例を示します。

namespace Company.Product
{
    /// <summary>
    /// These are the group comments for namespaces in <c>Company.Product</c>.
    /// </summary>
    [System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
    class NamespaceGroupDoc
    {
    }
}

NamespaceDocクラスがヘルプファイルに表示されないようにするには、publicキーワードを省略し、CompilerGenerated属性でマークします。

参考のためにここを参照してください：https ：//ewsoftware.github.io/SHFB/html/48f5a893-acde-4e50-8c17-72b83d9c3f9d.htm

于 2018-09-18T07:58:30.640 に答える
1

あなたは以下を使用してdoxygenでそれを行うことができます：

/// <summary>
/// description
/// </summary>
namespace name{};

また、NameSpaces.csファイルで名前空間を宣言し、このファイルでのみコメント化することをお勧めします。

于 2016-02-29T22:10:37.357 に答える
0

Monoのmdocドキュメントシステムを使用している場合は、ns-*。xmlドキュメントファイルを編集して名前空間メンバーをドキュメント化できます。

詳細については、mdocファイル形式のドキュメントを参照してください。

于 2009-09-22T02:32:16.420 に答える
0

名前空間にコメントを付けることはできません。

http://ndoc.sourceforge.net/content/documenters.htmのUseNamespaceDocSummaries

于 2009-04-27T12:10:01.640 に答える