ブログ「サイバー少年」

ブログ「サイバー少年」へようこそ!
小学六年生ごろからプログラミングを趣味にしている高校生のブログです。
勉強したことについての記事などを書いています。フリーソフトも制作、公開しています。
(当ブログについて詳しくは「ブログ概要紹介」を参照)

サイバー少年が作ったフリーソフトは「サイバー少年の作品展示場」へ

[C#] XMLコメントの勉強まとめ

前回の記事で、「XMLコメントをつけて公開したい」と言いましたが、

予想以上にXMLコメントは難しかった…。


サブブログのほうでも、<include>が理解不能だと書きましたが、仕組みがよく分からなかったんですよ。

ただ一度、覚えてしまえば簡単な仕組みだと感じられます。

というわけで、まだ各タグの意味とか使い方は、全然、覚えていないのですが、
仕組みがどういうものかは分かったので、書いていきます。




─ XMLコメントの仕組み ─


・C#コードファイル中に///から始まるコメントを書くと、XMLコメントという、メンバの説明をするドキュメントを作成できる。


・XMLコメントを書くと、コンパイル時、C#コンパイラがXMLファイルを作成する。
それをアセンブリと同じパス、名前で配置すると、参照が可能になる。
(Assembly.dllなら、Assembly.xmlとする。)

・実は、既定ではXMLファイルを作成しない設定となっている。
XMLコメントは普通のコメントと同様、アセンブリには埋め込まれないため、XMLコメントを書いても、もちろん参照できない。
ただし、同じプロジェクト内ではVisual Studioのスーパーパワーによって、XMLコメントとして参照できる。


─ <include>タグの仕組み ─


・includeタグで、なんらかのXMLファイルの名前と、XMLの要素を指定すると、
コンパイル時に、指定されたXMLファイルの、指定された要素を呼び出して、埋め込む。


↑最初はVisual Studioがincludeを見つけたときに呼び出す、動的リンクの要領だと思っていましたが、
どうやら作成されるXMLファイルに内容がコピーされる静的リンクみたいです。


(パスや、要素を指定する方法は省略します。)




<include>がよく分からなかったのは、
「<include>を使うと動的リンクされる」という先入観があったからだと思います。

まさか、はじめから結合されるとは…。

それにしても、まだ仕組みがどんなものか分かっただけで、タグの意味、使い方はこれからですよ。

こっちが本題ですからね。

まぁ、すぐに覚えられるでしょう。

必要性がでれば覚えていく形にしたいと思います。


そして、これを例のライブラリに付けると思うと、まだまだ掛かりそうですね。

tag:

コメント

コメントの投稿

トラックバック

トラックバック URL
http://cyberboy6.blog.fc2.com/tb.php/268-4a5ab5ce
この記事にトラックバックする(FC2ブログユーザー)

当ブログをご利用(閲覧等)になる場合は必ず「当ブログの利用規定」をお守りください。