1

C++ プロジェクトで doxygen を使用したとき、単純に次のように書きました。

/**
* I can refer to SomeClass or even SomeClass::someMethod() without special markup.
*/

次に、doxygen は「SomeClass」および「SomeClass::someMethod()」文字列から適切なドキュメントへのリンクを生成します。

現在、私は C# を使用しており、C# コードからドキュメントを生成するために SandCastle を使用したいと考えています。リンクはxmlタグで構築する必要があることに気付きました：

/// <see cref="SomeClass"/> and <see cref="SomeClass.someMethod()"/>

非常に煩雑で読みにくいと思います。

特別なマークアップなしでクラスとメソッドのリンクを生成する方法はありますか? C# プロジェクトのドキュメントをどのように生成しますか?

ありがとうございました。

4

1 に答える 1

3

特別なマークアップなしでクラスとメソッドのリンクを生成する方法はありますか?

私はそうは思わない。実際、XML ドキュメント (形式)は、sandcastle の機能ではなく、C# コンパイラの機能です。Sandcastle (および NDoc などの他のツール) は、「単純に」その上に構築されます。

C# プロジェクトのドキュメントをどのように生成しますか?

SandcastleとSandcastle Helpfile Builder (SHFB)を使用しています。また、GhostDocと ReSharper を使用して、XML コメントの作成と (オンザフライでの) 検証を支援します。たとえば、参照する型、メソッド、またはその他が実際に存在するかどうかなどです。

Doxygen を使用して、C# コードで Doxygen スタイルのコメントを使用することもできると思いますが、個人的には試したことはありません。Doxygen のWeb サイトを確認する必要があります。ただし、XML ドキュメント ( ReSharper のクイック ドキュメントなど) に基づいて他のツールが提供する機能や、最も目立つ機能である Intellisense のヘルプ/説明テキストを見逃してしまいます。

于 2012-06-22T06:45:09.997 に答える