DOBON.NETプログラミング掲示板過去ログ
Namespace のドキュメントコメントについて
題名: Namespace のドキュメントコメントについて
著者: 末
日時: 2008/07/18 15:27:29
ID: 22464
この記事の返信元:
(なし)
この記事への返信:
[22468]
Re[1]: Namespace のドキュメントコメントについて
オノデラ
2008/07/19 10:55:27
ツリーを表示
環境/言語:[WindowsXP, C#, .NET Framework2.0]
分類:[.NET]
度々お世話になります。
Sandcastle Help File Builder 1.5.0.1 を使用し
開発プログラムのヘルプファイル(*.chm)を作成しております。
クラスや関数に、コメントタグを付加し、Builderを実行した後に
出力したヘルプファイルを見ると、Namespace のコメント欄が赤字(未設定のための注意言文)になります。
Builder の出力プロパティを変更し、赤字を表示しないようには出来ると思うのですが
Namespace のドキュメント用のコメントは、どのように記載するのでしょうか?
クラスや関数と同様に、<summary>〜</summary>と書いても、「XMLコメントが有効な言語要素の中にありません」と怒られ
コンパイル出来ませんでした。
調べておりますが、まだ分からずにおります。
(どのサンプルを見ても、Namespace にはコメントらしきコードがありません)
ご存知の方、いらっしゃいましたら、教えて頂けないでしょうか?
宜しく御願い致します。
題名: Re[1]: Namespace のドキュメントコメントについて
著者: オノデラ
URL:
http://sorceryforce.com/
日時: 2008/07/19 10:55:27
ID: 22468
この記事の返信元:
[22464]
Namespace のドキュメントコメントについて
末
2008/07/18 15:27:29
この記事への返信:
[22472]
【報告】この投稿はマルチポストです
(報告)
2008/07/20 12:22:32
ツリーを表示
末さんこんにちは、オノデラです。
Sandcastle Help File Builder を開いてプロジェクトを読み込み、または作成したら、ウインドウの右上にある「Namespaces」ボタンをクリックしてみてください。
「Namespace Summaries」というダイアログが表示され、中央のリストに名前空間の一覧が表示されるので、説明文を入力したい名前空間を選択して下のテキストボックスに説明文を入力すればOKだと思います。
【環境】
Sandcastle - Version 2.4.10520
Sandcastle Help File Builder 1.7.0.0 Production
題名: 【報告】この投稿はマルチポストです
著者: (報告)
日時: 2008/07/20 12:22:32
ID: 22472
この記事の返信元:
[22468]
Re[1]: Namespace のドキュメントコメントについて
オノデラ
2008/07/19 10:55:27
この記事への返信:
[22476]
Re[3]: 【報告】この投稿はマルチポストです
末
2008/07/22 10:01:15
[解決]
ツリーを表示
この投稿はマルチポストです。
●マルチポストされている場所
http://www.atmarkit.co.jp/bbs/phpBB/viewtopic.php?topic=45689&forum=7
----------
この掲示板ではマルチポストが禁止されています。詳しくは、「書き込みのマナーについて」をお読みください。
●書き込みのマナーについて
http://dobon.net/vb/bbs/index.html
題名: Re[3]: 【報告】この投稿はマルチポストです
著者: 末
日時: 2008/07/22 10:01:15
ID: 22476
この記事の返信元:
[22472]
【報告】この投稿はマルチポストです
(報告)
2008/07/20 12:22:32
この記事への返信:
(なし)
ツリーを表示
>オノデラ様
ご回答有難うございます。
教えて下さいました方法で、Namespace にコメントを出力する事ができました。
.NET のコード上で記載するものとばかり考えておりました。
Sandcastle Help File Builder で設定するとは・・・。
名前空間は、複数のクラスに属する場合が多いと思うので
どのクラスに、名前空間コメントを書くのが普遍的であるのか謎でしたが
そもそも、コードには書けないのですね。
(名前空間コメント用のクラスを新規で作るべきかと考えました)
本当にありがとうございました。
>報告者様
マルチポストと言われてしまって、驚きました。
URL先の質問は、僕ではありません。
同じ日に、同じような質問を投げるとは、かなり偶然です。信じてください(汗)
おそらく、成果物が7月末納品で、最後のドキュメント生成に追われる
同じような身の方だと思いますが。
解決済み!
DOBON.NET
|
プログラミング道
|
プログラミング掲示板
分類:[.NET]
度々お世話になります。
Sandcastle Help File Builder 1.5.0.1 を使用し
開発プログラムのヘルプファイル(*.chm)を作成しております。
クラスや関数に、コメントタグを付加し、Builderを実行した後に
出力したヘルプファイルを見ると、Namespace のコメント欄が赤字(未設定のための注意言文)になります。
Builder の出力プロパティを変更し、赤字を表示しないようには出来ると思うのですが
Namespace のドキュメント用のコメントは、どのように記載するのでしょうか?
クラスや関数と同様に、<summary>〜</summary>と書いても、「XMLコメントが有効な言語要素の中にありません」と怒られ
コンパイル出来ませんでした。
調べておりますが、まだ分からずにおります。
(どのサンプルを見ても、Namespace にはコメントらしきコードがありません)
ご存知の方、いらっしゃいましたら、教えて頂けないでしょうか?
宜しく御願い致します。