Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > win32oleライブラリ > WIN32OLE_METHODクラス > helpstring

instance method WIN32OLE_METHOD#helpstring

helpstring -> String | nil[permalink][rdoc]

メソッドのヘルプ文字列を取得します。

helpstringは、IDEがメソッドのバルーンヘルプを表示するような場合に利用可能な、1行程度でメソッドを説明する文字列です。

[RETURN]

ヘルプ文字列を返します。未定義ならばnilを返します。

tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'IWebBrowser')
method = WIN32OLE_METHOD.new(tobj, 'Navigate')
puts method.helpstring # => Navigates to a URL or file.