1

この質問は、この質問 Code documentation how much is too much?から生じています。

答えの 1 つは、xml ドキュメントを別のファイルに保存することでした。コードを調べているときにドキュメントの冗長性が煩わしいのに対し、インテリセンスを介して適切なメソッドを検索したり、ドキュメントを公開したりするときに冗長性が役立つため、その答えが本当に気に入りました。

答えは include タグを使用することでした

/// <include file="Documentation/XML/YourClass.xml" path="//documentation/members[@name='YourClass']/*"/>

include タグに関する MSDN の記事もここにあります。

概要情報を非表示にする方法はわかりましたが、方法のドキュメントをそこに配置する方法もわかりませんでした。(これは、クラスの概要自体よりも重要です。

4

1 に答える 1

1

答えは簡単です。生成された xml ファイルを読み取ります。これらは、分離された xml ファイルがどのように見えるべきかを示しています。

生成された xml ファイルの読み取りとメソッドの記述方法 (パラメーターなどを使用):

<member name="M:BitFactory.Logging.Logger.DoLog(BitFactory.Logging.LogEntry)">
    <summary>
    Really log aLogEntry. (We are past filtering at this point.)
    Subclasses might want to do something more interesting and override this method.
    </summary>
    <param name="aLogEntry">The LogEntry to log</param>
    <returns>true upon success, false upon failure.</returns>
</member>

T、M、F プレフィックス タイプ、メソッド、フィールド。

于 2009-03-09T17:48:58.223 に答える