67

少し前に、私たちのプロジェクトの 1 つのドキュメント Web サイトを生成するためにSandcastleを使い始めました。非常にうまく機能していますが、私たちは常にプロジェクトのクラス、メソッド、プロパティ (...) のドキュメントのみを作成し、プロジェクト全体とプロジェクトのパーツ/モジュール/名前空間のドキュメントを完全に分離していました。そのドキュメントをまとめて、生成されたヘルパー ファイルにそれぞれのドキュメントを追加できればいいのですが、その方法がわかりません。

名前空間宣言にコメントを追加するだけでは機能しないようです (C#):

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

誰もこれを行う方法を知っていますか? どういうわけかそれが可能であることを知っています、そしてそれがあれば本当にいいでしょう... :)

4

7 に答える 7

80

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 のワークアイテムはここにあり ます。

于 2009-05-13T09:49:25.783 に答える
19

Sandcastle Help File Builderを使用している場合は、名前空間の概要を入力するためのダイアログが表示されます。(特定のクラスの定義もサポートしているようですが、私はそれを好みません..)

機能リストから:

ヘルプ ファイルに表示されるプロジェクトの概要と名前空間の概要コメントの定義。ヘルプ ファイルに含めたり除外したりする名前空間を簡単に指定することもできます。各ネームスペース内の NamespaceDoc クラスを介してネームスペース コメントを指定するためのサポートも含まれています。

于 2008-10-01T08:17:20.493 に答える
8

Sandcastle Help File Builderを使用します。XML プロジェクト ファイルで名前空間の説明を指定できます。

例：

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

参考文献:

.

于 2008-10-01T08:40:14.493 に答える
4

I know it's an old post, but this may be of help to someone else.

Following this link, you can set a description for the namespaces without the need of adding a non-public class to your project.

To edit the namespace summaries, expand the Summaries section within the Project Properties tab in SHFB. You will see a setting named, "NamespaceSummaries", which initially shows the value, "(None)". Click the setting to select it and a button showing an ellipsis symbol (...) appears. Click this button to display the Namespace Summaries dialog box, pictured below:

enter image description here

于 2016-08-08T15:55:04.140 に答える
1

そのように参照を追加することはできません- NamespaceDoc.cs インスタンスを介して行います

すなわち

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

ここを参照

于 2014-04-28T10:47:57.143 に答える
0

「外部 XML コメント ファイル」のドキュメントが表示されます。次のようなスキーマを表示します。

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

これを別のファイルに配置する場合、拡張子は (xml/aml) になり、これを Visual Studio プロジェクトで使用できますか?

于 2018-02-01T22:00:23.930 に答える