none
ビルド時に出力されるXMLドキュメントの使い方 RRS feed

  • 質問

  • VS2008でコンパイルをしたときに出力されるXMLファイルの使い道がよく分かりません。

    「Sandcastle、NDoc等のヘルプ作成ツールを利用して仕様書を作る」という使い方が一般的なのでしょうか?

    VS2005→VS2008に変えるとき変換ウィザードでXMLのレポートが出力されますが、

    同じように公式に扱う方法などあるのでしょうか?

    よろしくお願いします。

    2008年9月2日 10:23

回答

  •  アー さんからの引用

    VS2008でコンパイルをしたときに出力されるXMLファイルの使い道がよく分かりません。

    「Sandcastle、NDoc等のヘルプ作成ツールを利用して仕様書を作る」という使い方が一般的なのでしょうか?

    ドキュメント生成のために使うという用途が一般的ですね。つまりは、Sandcastleになるわけですが。

    ソースコード中にコメントを書くことで、MSDNドキュメントみたいなヘルプファイルができあがるのは魅力的です。

     

     アー さんからの引用

    VS2005→VS2008に変えるとき変換ウィザードでXMLのレポートが出力されますが、

    同じように公式に扱う方法などあるのでしょうか?

    どうだろう…。

    コンパイル時のXMLはクラスライブラリ等を説明するドキュメントとして価値は高いけれども、変換ウィザードでのXMLは用途について聞き覚えがありません。

    2008年9月2日 14:58
    モデレータ
  •  アー さんからの引用

    VS2008でコンパイルをしたときに出力されるXMLファイルの使い道がよく分かりません。

    「Sandcastle、NDoc等のヘルプ作成ツールを利用して仕様書を作る」という使い方が一般的なのでしょうか?

     

    IntelliSenseが利用してくれます.

    生成されたDLLと一緒にドキュメントXMLも配布しておくと,そのDLLを参照する外部のプロジェクトで,開発時に役立ちます.

    もちろん実行時にドキュメントXMLは不要です.

    2008年9月3日 3:25
  • 「Sandcastleでドキュメント生成のために使う」が一般的なんですね。

    でもデフォルトでわざわざXMLファイルを出力する設定になっているなら、

    Sandcastleをつけてドキュメントを見れる設定までしてほしい気がしました。

     

     Azulean さんからの引用

    どうだろう…。

    コンパイル時のXMLはクラスライブラリ等を説明するドキュメントとして価値は高いけれども、変換ウィザードでのXMLは用途について聞き覚えがありません。

    変換ウィザードのXMLは結果を見た後は価値がなさそうだったので削除するようにしました。

     

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

    2008年9月3日 12:43
  •  NyaRuRu さんからの引用

    IntelliSenseが利用してくれます.

    生成されたDLLと一緒にドキュメントXMLも配布しておくと,そのDLLを参照する外部のプロジェクトで,開発時に役立ちます.

    もちろん実行時にドキュメントXMLは不要です.

    IntelliSense・・・入力支援機能

    これが使えるのは確かに大きいですね!

    大変参考になりました。

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

    2008年9月3日 12:47

すべての返信

  •  アー さんからの引用

    VS2008でコンパイルをしたときに出力されるXMLファイルの使い道がよく分かりません。

    「Sandcastle、NDoc等のヘルプ作成ツールを利用して仕様書を作る」という使い方が一般的なのでしょうか?

    ドキュメント生成のために使うという用途が一般的ですね。つまりは、Sandcastleになるわけですが。

    ソースコード中にコメントを書くことで、MSDNドキュメントみたいなヘルプファイルができあがるのは魅力的です。

     

     アー さんからの引用

    VS2005→VS2008に変えるとき変換ウィザードでXMLのレポートが出力されますが、

    同じように公式に扱う方法などあるのでしょうか?

    どうだろう…。

    コンパイル時のXMLはクラスライブラリ等を説明するドキュメントとして価値は高いけれども、変換ウィザードでのXMLは用途について聞き覚えがありません。

    2008年9月2日 14:58
    モデレータ
  •  アー さんからの引用

    VS2008でコンパイルをしたときに出力されるXMLファイルの使い道がよく分かりません。

    「Sandcastle、NDoc等のヘルプ作成ツールを利用して仕様書を作る」という使い方が一般的なのでしょうか?

     

    IntelliSenseが利用してくれます.

    生成されたDLLと一緒にドキュメントXMLも配布しておくと,そのDLLを参照する外部のプロジェクトで,開発時に役立ちます.

    もちろん実行時にドキュメントXMLは不要です.

    2008年9月3日 3:25
  • 「Sandcastleでドキュメント生成のために使う」が一般的なんですね。

    でもデフォルトでわざわざXMLファイルを出力する設定になっているなら、

    Sandcastleをつけてドキュメントを見れる設定までしてほしい気がしました。

     

     Azulean さんからの引用

    どうだろう…。

    コンパイル時のXMLはクラスライブラリ等を説明するドキュメントとして価値は高いけれども、変換ウィザードでのXMLは用途について聞き覚えがありません。

    変換ウィザードのXMLは結果を見た後は価値がなさそうだったので削除するようにしました。

     

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

    2008年9月3日 12:43
  •  NyaRuRu さんからの引用

    IntelliSenseが利用してくれます.

    生成されたDLLと一緒にドキュメントXMLも配布しておくと,そのDLLを参照する外部のプロジェクトで,開発時に役立ちます.

    もちろん実行時にドキュメントXMLは不要です.

    IntelliSense・・・入力支援機能

    これが使えるのは確かに大きいですね!

    大変参考になりました。

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

    2008年9月3日 12:47