こんにちはゲストさん。会員登録(無料)して質問・回答してみよう!

解決済みの質問

C#で作成したプログラムのAPIリファレンスを作成したい

はじめまして。
現在OSがWindows Vistaで、IDEがVisual Studio 2005 Express Edition
を利用して、C#でアプリケーションを作成していまして、
コードにXMLコメントを挿入しています。それで、そのXMLコメント
を利用してAPIリファレンスみたいなものを作りたいのですが
どなたかよいツールをご存じないでしょうか。アドバイスお願いします。

投稿日時 - 2008-07-24 16:57:45

QNo.4200954

すぐに回答ほしいです

質問者が選んだベストアンサー

「SandCastle」自体はご存知のようですね。
他で質問されている「sandcastleでヘルプ画面が表示されません。 」に関しては
最近は使ってないのでわかりません。
以前のバージョンでは私自身Sandcastle Help File Builder を使って
問題なくchmファイルを出力できていました。
ちなみSandcastleで生成したchmファイルですが
samba上の共有ファイルからは閲覧できず
ローカルにコピーしないと閲覧できなかった覚えはあります。

投稿日時 - 2008-07-24 19:43:41

お礼

sha-girl 様へ
ご回答ありがとうございました。chmファイルが格納場所により
内容が、表示されたりされなかったりすることがあることを知りまして
貴重なヒントをいただきました。試しにchmファイルをコピーして
別のフォルダに格納して、閲覧したところ、見事に閲覧することが
できました。chmファイルを当初は、\bin\Release 配下に格納
していたのですが、この場所では、chmファイルを閲覧することが
できませんでした。それで、chmファイルをPublicフォルダに
コピーして、格納して閲覧したら閲覧することができました。
Vista でもchmファイルの閲覧はできるんですね。
大変勉強になりました。ありがとうございました。

投稿日時 - 2008-07-24 20:56:31

このQ&Aは役に立ちましたか?

15人が「このQ&Aが役に立った」と投票しています

回答(2)

ANo.1

>コードにXMLコメントを挿入しています。それで
xmlコメントとは
///<summary>コメント</summarry>
///<returns>戻り値</returns>
みたいな形式ですよね?
だとすると「SandCastle」じゃないですかね。
機能的にはdoxygenとほぼ同じで
msdnのような、ヘルプファイルを作れます。

「SandCastle」で検索すれば良い情報が得られると思います。
http://journal.mycom.co.jp/articles/2008/07/17/Sandcastle/index.html

投稿日時 - 2008-07-24 19:27:25

お礼

sha-girl 様へ
ご回答ありがとうございます。実は、sandcastle と sandcastle Help File Builder を使用して、chmファイルを作成したところまでは、
順調だったのですが、いざchmファイルを閲覧しようとすると、内容が
画面に表示されない状態になっていました。それで、
画面に表示されない理由が何なのかがわからず、ネットで
調査していました。それで、答えが見つからずに途方に暮れていた
ところだったのです。それで、他の別の方法がないかと思い
質問した次第でした。

投稿日時 - 2008-07-24 20:46:39