メソッド記述のXMLコメントを別のファイルに保存するにはどうすればよいですか?
-
03-07-2019 - |
質問
この質問はこの質問に由来しています コードのドキュメントはいくらですか?
答えの1つは、XMLドキュメントを別のファイルに保存することでした。コードを調べているときはドキュメントの冗長性がうっとうしいのに対し、インテリセンスを介して適切なメソッドを検索したりドキュメントを公開したりする場合は冗長性が役立つため、この回答が本当に気に入りました。
答えはincludeタグを使用することでした
/// <include file="Documentation/XML/YourClass.xml" path="//documentation/members[@name='YourClass']/*"/>
インクルードタグに関するMSDNの記事もありますこちら。
要約情報を保持する方法を考え出しましたが、方法のドキュメントをそこに配置する方法がわかりませんでした。 (クラスの概要自体よりも重要です。
解決
答えは簡単です。生成された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プレフィックスタイプ、メソッド、フィールド。
所属していません StackOverflow