フォーラム


ゲスト  

ようこそ ゲスト さん。このフォーラムに投稿するには 登録が必要です。

ページ: [1]
トピック: XML ドキュメントコメント
DEKO
管理者
投稿数: 2690
XML ドキュメントコメント
on: 2015/09/30 02:04 Wed

XE2 からの機能ですが、XML ドキュメントコメントってのがありまして、クラスのメンバや普通のメソッド (関数 / 手続き) の宣言部の上部に三連コメントで XML を記述しておくとヘルプインサイト (関数とかにマウスオーバーすると出てくる奴) に表示されるようになります。

他人に公開するようなソースコードには地味に便利です。

See Also:
[ヘルプインサイト (DocWiki)]
http://docwiki.embarcadero.com/RADStudio/ja/%EF%BC%BB%E3%83%98%E3%83%AB%E3%83%97_%E3%82%A4%E3%83%B3%E3%82%B5%E3%82%A4%E3%83%88%EF%BC%BD
[XML ドキュメントコメント (DocWiki)]
http://docwiki.embarcadero.com/RADStudio/ja/XML_%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88_%E3%82%B3%E3%83%A1%E3%83%B3%E3%83%88

DEKO
管理者
投稿数: 2690
Re: XML ドキュメントコメント
on: 2015/09/30 02:26 Wed

え?三連コメントとタグを入力するのがメンドイ?いえいえそんな事はありません。
ドキュメントコメントを入力したい場所に移動し、summary と入力した後に [Ctrl]+[J] を押してみましょう。

    /// <summary>
///
/// </summary>

 
こんなのが自動で挿入されます。param や returns、remarks なんかも同様です。

テンプレートの呼び出し方は [支援機能] の設定により異なり、例えば summary と入力後に、

  • (リスト選択) [Enter]
  • [Ctrl]+[Space] (リスト選択) [Enter]
  • [Tab]
  • [Ctrl]+[J]

と、色々な呼び出し方があります…ただ、どの設定にしても [Ctrl]+[J] を押せば必ず出ます ([支援機能] の設定がすべてオフでも)。

See Also:
[ライブテンプレート (DocWiki)]
http://docwiki.embarcadero.com/RADStudio/ja/%E3%83%A9%E3%82%A4%E3%83%96_%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88
[支援機能 (DocWiki)]
http://docwiki.embarcadero.com/RADStudio/ja/%EF%BC%BB%E6%94%AF%E6%8F%B4%E6%A9%9F%E8%83%BD%EF%BC%BD

ページ: [1]
WP Forum Server by ForumPress | LucidCrew
バージョン: 1.7.5 ; ページロード: 0.022 sec.