コメント書きましょう

クラスやメソッド、プロパティ、フィールドにはコメント書きましょうね。

/// <summary> /// メソッドのサンプルです。入力値を10倍して返します。 /// </summary> /// <example> /// int hoge = sample(1); /// if( hoge==10 ) /// Console.out.writeln("HAGE!!"); /// </example> /// <param name="a">10倍する値</param> /// <exception cref="Exception">ゼロが入力されたらダメなんですね。</exception> /// <returns>10倍された値が返されます。</returns> public int sample ( int a ) { if( a==0 ) throw new Exception("shine"); return a*10; }

こんな感じだ。いや、こんなてきとーぢゃダメだよ?

各タグの意味

<c>

<para>

<see>

<code>

<param>

<seealso>

<example>

<paramref>

<summary>

<exception>

<permission>

<typeparam>

<include>

<remarks>

<typeparamref>

<list>

<returns>

<value>

中身書くのメンドイからmsdnにとびます。。。

必要なもの

Sandcastle

ご存知、XMLからHTML Helpに変換する物体。
http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en

Visual Studio 2008 SDK 1.1

http://www.microsoft.com/downloads/details.aspx?familyid=59EC6EC3-4273-48A3-BA25-DC925A45584D&displaylang=en

Sandcastle Help File Builder

SandcastleをGUIから扱えるようにする物体。
http://www.codeplex.com/SHFB

で、どーするのかっちゅーと

  1. Sandcastle Help File Builderを起動しなさい。

  2. Addボタンをクリックして対象のXMLファイルとDLLファイルを指定したまえ。

  3. Project Propertiesを適当に設定しておけ。

  4. Ctrl + Shift + B

    ビルドが終わるまで待て。

  5. Ctrl + Shift + V でヘルプファイル開けるで。

Project Propertiesが解らねぇ!?

わかれ。

どうだ?

逆にこれで「分かった!!」なんて言われても怖いけどな。

HTML Help 2.xにしてみる

HelpFileFormatでHtmlHelp2xにしても、インストールしなきゃ見れません。

っちゅーことで、インストール方法。

  1. Visual Studio 2008 SDK 1.1をインストールしといてください。ダウンロードページのリンクは上の方見てくれ
  2. Visual Studio 2008を起動
  3. ファイル新規作成プロジェクト。別にショートカットでやっても良いぞ
  4. プロジェクト名を適当につけて、ソリューションのディレクトリを作成にチェックを入れてOKだ
  5. 特に変えなくて良いはずだから、そのままNextをクリックしなさい
  6. Addをクリックして、.HxSファイルを指定してやる。このファイルはSandcastleで出力されるやつだ
  7. 指定したらNextをクリックしたまえ
  8. その次は、特に変えなくて良い。とりあえずはね。Nextをクリックしておけ
  9. その次も、とりあえず変更しないでFinishでいい
  10. プロジェクトが作成されるから、ビルドしてインストールしてみろ