- PR -

ヒントで表示される説明の指定方法が知りたいのですが

1|2 次のページへ»
投稿者投稿内容
Ｒ・田中一郎
ぬし
会議室デビュー日: 2005/11/03
投稿数: 979
投稿日時: 2006-04-10 16:24
コードエディタ上でプロパティやメソッドにポインターを合せると、引数や戻り値の
情報が表示されますが、次の行に、その説明まで表示されるものがあります。

自作したプロパティやメソッドでも、この説明を表示させたいのですが、どのように
指定すれば良いのでしょうか？
Yam
大ベテラン
会議室デビュー日: 2003/09/13
投稿数: 179
お住まい・勤務地: だんじり祭りの地
投稿日時: 2006-04-10 16:35
やは！
メソッド等の宣言の直上行に「///」と入力すると。。。

<summary>タグに入力した文字列がメソッドの説明に、
<param name="hoge">タグに入力した文字列が引数hogeの説明になります。
_________________
音速の定時退社！
かるあ
ぬし
会議室デビュー日: 2003/11/16
投稿数: 1190
お住まい・勤務地: センガワ→ムサシノ
投稿日時: 2006-04-10 16:52
引用:

Ｒ・田中一郎さんの書き込み (2006-04-10 16:24) より:
コードエディタ上でプロパティやメソッドにポインターを合せると、引数や戻り値の
情報が表示されますが、次の行に、その説明まで表示されるものがあります。

自作したプロパティやメソッドでも、この説明を表示させたいのですが、どのように
指定すれば良いのでしょうか？



VisualStudio のバージョンと 言語によって異なります。
「ドキュメンテーションコメント」とかで検索すると出てきます。
Yam
大ベテラン
会議室デビュー日: 2003/09/13
投稿数: 179
お住まい・勤務地: だんじり祭りの地
投稿日時: 2006-04-10 17:02
引用:

かるあさんの書き込み (2006-04-10 16:52) より:
VisualStudio のバージョンと 言語によって異なります。

そうでした。
「///」はC#の場合です。
_________________
音速の定時退社！
Ｒ・田中一郎
ぬし
会議室デビュー日: 2005/11/03
投稿数: 979
投稿日時: 2006-04-10 17:17
C# なのでYamさんの例でいけました。
ありがとうございます。

よく見かけていて気になってたんですが、こういう意味だったんですね。

てっきり、アウトラインで折りたたむときに関係するものだと勘違いしていました。
＃これが伏線となって、後から知って妙に感動した訳です。
じゃんぬねっと
ぬし
会議室デビュー日: 2004/12/22
投稿数: 7811
お住まい・勤務地: 愛知県名古屋市
投稿日時: 2006-04-10 18:06
最近似たようなスレッドがあったのですが...

　(;´･ω･`)σ 自作関数参照時の説明文

_________________
C# と VB.NET の入門サイト
じゃんぬねっと日誌
Ｒ・田中一郎
ぬし
会議室デビュー日: 2005/11/03
投稿数: 979
投稿日時: 2006-04-11 10:45
引用:

じゃんぬねっとさんの書き込み (2006-04-10 18:06) より:
最近似たようなスレッドがあったのですが...

　(;´･ω･`)σ 自作関数参照時の説明文

そうだったんですね。見落としていました。申し訳ありません。

しかし2003では自分でxmlに書かねばいけなかったんですね。今は便利です。

実際に使ってみて思ったんですが、僕が以前から多用しているコメントのスタイルと
ちょっと似ていて違和感なく使えます。

ちなみに、こんな感じです。
コード:

'***********************************************
' 目的の文字列を配列中から検索
' in:   targetString 検索した文字列
' ret:  発見した要素数
' memo: 見つからないときは、-1 を返します。
'***********************************************

上記は、vb6 の場合でしたが、perl とか cobol でも、こんな感じで使っていました。
まあ、誰でも大体こんな感じで書いていたんでしょうけどね。
ぼのぼの
ぬし
会議室デビュー日: 2004/09/16
投稿数: 544
投稿日時: 2006-04-11 11:21
XML形式のコメントにしておくと、後からMSDN風のリファレンスを作れるので便利ですね。

.NET TIPS C#でMSDNライブラリ風のAPIリファレンスを作成するには？

私はVS2003でプロジェクト参照してるので説明の表示は諦めてますが、
初めてNDocを使った時は、VS標準機能で作ったリファレンスより
全然立派なのでちょっと感動しました。
1|2 次のページへ»

スキルアップ／キャリアアップ（JOB@IT）