2013/03/09 VisualStudio勉強会 LT 「統合開発環境の支援ツール」

Visual Studio勉強会LT

統合開発環境の支援ツール

2013/03/09 野田悟志@scarviz

自己紹介

名前　野田悟志@scarviz

仕事　C#で業務系システム開発

主な活動　日本Androidの会 神戸支部

　GDG神戸　　＞最近Go言語についてブログ書いてます！

VS VS

今日はVisualStudioの素晴らしい面を

いっぱい見てきたと思います

VS VS

皆さんきっと

VisualStudioすごいVisualStudioたよりになるVisualStudioつかいやすいVisualStudioでよかったVisualStudioでAndroidしたいEclipseクソ

VS VS

プロジェクト作成からユニットテストまで開発に必要なことは何でも出来るそう

Visual Stadio ならね！

VS VS

ただ、それだと･･･

ア○プル信者と変りませんよ！

このVS信者どもめ！

VS信者の嘘

よくよく考えてくださいVisualStudioは開発者の

飯を作ってくれません！

VS信者の嘘

よくよく考えてくださいVisualStudioは開発者のために

ドキュメント整備をしてくれません！

VS信者の嘘

よくよく考えてくださいVisualStudioは開発者が将来安心して開発できるように

女の子を紹介してくれません！

一方

その点Eclipseは潔いですよ！

一方

開発環境としていまいちですそう

Eclipseならね！

VSって･･･

出来ないこともあるし、潔くも無いつまり

VSクソ

本当に申し訳ありませんでした

･･･ 。すいません。

調子に乗りました。

とはいえ

せめて

ドキュメント整備くらいやってくれたっていいじゃないか

と思いませんか？

というと

VSだけでは出来ないんですが、

実はクラスやメソッドなどの定義一覧をつくるくらいのこと

が出来るんです

本題へ

ということで

無駄に時間をつかってやったところでそろそろ本題に入ります

支援ツール

Sandcastle(サンドキャッスル)

って知ってますか？

Sandcastleとは

VSでビルドする時にXMLドキュメントコメントを出力することができるんですが、それを使って、ヘルプドキュメントを作るものです

←XMLドキュメントコメントとは　これのこと

←これも

1. 必要なものを準備

Sandcastleを実行するには以下がインストールされている必要があります

・Microsoft .NET Framework Version 2.0・HTML Help Workshop

1. 必要なものを準備

2. Sandcastleをインストール

3. バッチファイルをコピー

インストール先の\Examples\Sandcastleから、build_Sandcastle.batをコピーして、任意のフォルダに格納してください

※環境変数の「DXROOT」の値がインストール先になっているのですが、最後の部分(\Sandcastle\の最後の\)は不要なので、取って保存し、PCを再起動します。ただ、間違ってはいますが、修正しなくても問題は無いようです

4. XMLファイルを出力する

5. EXE,DLL,XMLファイルを格納

build_Sandcastle.batを格納したフォルダに、ヘルプファイルを作成したい各プロジェクトのexeファイルまたはdllファイルとそのプロジェクトのxmlファイルを格納します

6. build_Sandcastle.batを編集

もしexeファイルのヘルプを出力したい場合はbuild_Sandcastle.batを編集します

MRefBuilder %2.dll /out:reflection.org→MRefBuilder %2.exe /out:reflection.org

6. build_Sandcastle.batを編集

privateなメンバやメソッドを出力する場合は、最後に「 /internal+」をつけます

MRefBuilder %2.dll /out:reflection.org↓

MRefBuilder %2.dll /out:reflection.org /internal+

7. Sandcastleの実行

コマンドプロンプトを起動し、カレントをbuild_Sandcastle.batを格納したフォルダまで移動し、下記を実行します

build_Sandcastle.bat prototype (exeまたはdllファイル名の拡張子なし）chm

7. Sandcastleの実行

「prototype」部分はprototype / vs2005 / hanaから選べます出力されるヘルプファイルの内容の形式が変ります

「chm」部分はhtml / chm / hxs / mshcから選べます出力されるヘルプファイル形式になります

8. 気長に待ちましょう

結構時間かかるので、気長に待ちましょう。

完成したヘルプファイルは、Outputフォルダか、chmファイルの場合、chmフォルダが作成され、その中に格納されています。

MSDNのリファレンスみたいな感じに仕上がったものが出来ていると思います。

完成したもの

ちょっと工夫する

ちょっとしたドキュメント、というものでなく、結構確りしたものができますね

exe,dll,xmlファイルをコピーしたり、build_Sandcastle.batを実行したりするバッチファイルを作っておくのがオススメです

※各フォルダは実行毎にクリアされるので、複数のヘルプファイルを一度に作成する場合は、作成したヘルプファイルを退避させる必要があるので気をつけてください！

ということで

こういう支援ツールに恵まれている面もあります

Visual Stadio ならね！

おわり

ご清聴ありがとうございました！