misc.log

日常茶飯事とお仕事と

C#/VB.NETドキュメンテーションコメントの「List」タグ

コメントからヘルプを作るドキュメントコメントで、箇条書きをスマートにやりたいなぁ、と思ったのですが意外にめんどくさそう。

(C# Programming Guide)
http://msdn.microsoft.com/en-us/library/y3ww3c7e(v=VS.100).aspx
<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>


Listに続いてタイプ指定で「中黒」「数字」「表形式」を選択、あとはヘッダーとアイテムで。アイテムは「Term」と「Description」があるので、見出しと説明、的な2段構成が可能なのか……。ヘッダーは表形式(table)の場合だけかなぁ…と思って下記のような感じで簡易版を試してみたら、できました。

<list type="bullet">
    <item>項目1</item>
    <item>項目2</item>
    <item>項目3</item>
</list>


これで、シンプルな「中黒箇条書き」になります。ちょーっと中黒の丸が大きすぎるのが個人的には気色悪いのですが…仕方ないか。typeの指定をnumberやtableにすれば、番号リストや表形式もこれでいけそう?