2009-03-04 6 views
1

この質問は Code documentation how much is too much?メソッドコメントのXMLコメントを別のファイルに保存するにはどうすればよいですか?

一つの答えは別のファイルにしてXMLドキュメントを維持することでした。この問題に由来します。私はコードを見ているときのように答えが気に入っていましたが、ドキュメンテーションの冗長さは面倒です。一方、冗長性はintellisenseで正しいメソッドを検索したりドキュメントを公開したりするときに便利です。

答えがインクルード私は要約情報を維持する方法を考え出したが、私は知らないタグ​​here.

を含めるに関するMSDNの記事もありインクルードタグ

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

を含める使用していましたメソッドドキュメンテーションをそこに置く方法も見つけられませんでした。 (どのクラスの概要そのものよりも重要である。

答えて

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プレフィックス型、メソッド、フィールド

関連する問題