編集し直した

こっち見てくれ

コメントのドキュメント化

なんと!C#ソースコードに記述したコメントをHTMLやHelp形式のドキュメントにできる!のだ!!

「遅せーよ!」とか言うんぢゃ無いよ。

必要なもの

[2007.12.17]C#のXMLコメントを見たまえ。

コメントちゃんと書いてるか?

/// <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にとびます。。。

で、どーするの?

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

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

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

  4. Ctrl + Shift + B

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

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

Project Propertiesが解らねぇ!?

わかれ。

どうだ?

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