DOBON.NET DOBON.NETプログラミング掲示板過去ログ

APIリファレンスの作成方法

環境/言語:[Visual Studio2005 standard edition(.net framework2.0.50727)]
分類:[.NET]

C#でドキュメントタグを書いて、APIリファレンスを出力しようと思ったのですが、
どうやって出力していいのか?分かりません。
http://www.atmarkit.co.jp/fdotnet/teamdev/teamdev01/teamdev01_02.html
↑上記を見て、いろいろと調べたのですが、
「VS.NETでC#のソリューション(プロジェクト)を開き、統合開発環境のメニューから、[ツール]−[Webページのビルド コメント]を実行する。」
と書いてあるのですが、「Webページのビルド コメント」が存在しません。
どうやって出力すればよいのでしょうか?
よろしくお願いします。
環境はVisual Studio2005 standard editionです。
(.net framework2.0.50727)
一緒に書くのはまずいと思うのですが、
APIだけでなく、UMLを出力とかは出来ないのでしょうか?
よろしくお願いします。
■No19105に返信(haruさんの記事)
> C#でドキュメントタグを書いて、APIリファレンスを出力しようと思ったのですが、
> どうやって出力していいのか?分かりません。
> http://www.atmarkit.co.jp/fdotnet/teamdev/teamdev01/teamdev01_02.html
> ↑上記を見て、いろいろと調べたのですが、
> 「VS.NETでC#のソリューション(プロジェクト)を開き、統合開発環境のメニューから、[ツール]−[Webページのビルド コメント]を実行する。」
> と書いてあるのですが、「Webページのビルド コメント」が存在しません。

私のサイトの次の記事をご覧になってください。

コードコメントWebレポートを作成するhttp://dobon.net/vb/dotnet/vs/commentwebreport.html

コードコメントWebレポートの機能は、VS2005ではなくなったようです。代わりにNDocのようなツールをお使いください。
NDocも開発終了ですので、SandCastleをお探しください。
SandCastle 日本語対応されてないですよね?
予定あるのかな。。。
いろいろとありがとうございました。
SandCastleを調べまして、一応動かしてみました。
しかし、HTMLヘルプが作成されません。
(ディレクトリのOutput\htmlにはいろいろなhtmlが作成されています)
いろいろと悩んでみたものの解決できません。
Dosプロンプトで出力されているメッセージを見ると、
エラーっぽいものが一応ありました。
しかし、これが原因しているかどうか?分かりません。
「Warn: SharedContentComponent: Missing shared content item 'propertiesTopicTitle'」
「Warn: SharedContentComponent: Missing shared content item 'propertiesIndexEntry'」
「Warn: SharedContentComponent: Missing shared content item 'propertiesTopicTitle'」
使いこなしている方とかはいらっしゃるのでしょうか?
参考にしたページ
http://hrgs.xrea.jp/2006/12/03/sandcastle_batch
何かアドバイスいただけたら光栄です。
よくわかりませんが「Warn: 」で始まっているのは警告でしょうから、
出力されない原因にはならないんじゃないでしょうか。

参考になるかわかりませんが、私はSandcastle Help File Builderという
フリーのGUIツールを使って作成してみました。

http://www.codeproject.com/dotnet/SandcastleBuilder.asp

DOBON.NET | プログラミング道 | プログラミング掲示板