2008年5月27日

VSのXMLドキュメントファイル

C#に本気ではないものの片足を突っ込んでみた。JavaにはJavaDocという便利なものが…C#には :?: あ、なんかXMLドキュメントがあるよぉ～と言うことで。

MSDNに在った「XMLドキュメントのサンプル」をダウンロードしてVisual Stdio 2005で、サンプルページの手順に従ってXMLドキュメントファイルを生成してみた。

なんか、良くわからないXMLだなぁ～それは仕方ないとしても…可視性（public, protected, private）の区別がないような気がするなぁ :?:

仕方ないので、prptectedとprivateを追加して再度XMLドキュメント生成してみた。結果は以下のようなXMLになった。

< ?xml version="1.0"?>
<doc>
    <assembly>
        <name>XMLdoc</name>
    </assembly>
    <members>
        <member name="T:SomeClass">
            <summary>
            クラス レベルの概要をここに挿入します。</summary>
            <remarks>
            もっと長いコメントは、remarks タグを使用して型または
            メンバに関連付けることができます。</remarks>
        </member>
        <member name="F:SomeClass.myNamePublic">
            <summary>
            name プロパティの格納場所 public</summary>
        </member>
        <member name="F:SomeClass.myNameProtected">
            <summary>
            name プロパティの格納場所 protected</summary>
        </member>
        <member name="F:SomeClass.myName">
            <summary>
            name プロパティの格納場所 private</summary>
        </member>
　　　　（省略）
    </members>
</doc>

可視性によって、XMLドキュメント（タグ）が全く変化しませんね :shock: 当初は、吐き出されたXMLをXSLTとかを書いて整形してあげれば簡単に加工ができるものと思っていたのですが…わたしが甘かったです :roll:

どうも、リフレクションとかで調べろってのかMicrosoftのスタンスのようです。『方法 : XML ドキュメント機能を使用する (C# プログラミング ガイド)』のメモに以下のように書かれてる。

XML ファイルでは、型やメンバに関する完全な情報は提供されません。たとえば、XML ファイルには型情報が含まれていません。型やメンバに関する完全な情報を得るには、ドキュメント ファイルを実際の型やメンバのリフレクションと共に使用する必要があります。

なんじゃ、そりゃあ！

そのためにSandcastleとかあるわけですね…と言うことで珍しくエントリが続くかも知れない ;)

でも、VSの生成するXMLドキュメントってこんなんで良いの :?: 教えてエロイ人。

5月 27th 2008 Posted to .NET,C#,VB,Windows,お仕事,ソフトウェア,プログラミング,開発環境

* Comments(2)       

TrackBack URL :

Comments

  1. Slashcolon /:
    5月 28th, 2008 | 9:27 PM

    C#のドキュメント定番は砂の城？…

    『VSのXMLドキュメントファイル』の続きエントリです 結局、VSから吐き出されるXMLファイルだけではどうにもならないことが判明。と言うことで調べてみた。
    Javaには、JavaDocという超定番…

  2. aiko
    7月 7th, 2008 | 6:27 PM

    書き忘れました。
    C#ならこれですね。
    http://www.hotdocument.net/product/cs.html
    http://www.hotdocument.net/document/DocCS3.html

Leave a reply


« »