HelpCommand

test/wmtools.js を読み込んでいるとDevToolsのコンソールで Help コマンドが使用可能になります。

使い方

ブラウザの DevTools のコンソールを開き、 Help("keyword") や keyword.help とタイプすると状況に応じたヘルプを表示します。

Function文

Help コマンドのサポートをうける関数は、function 式ではなく、function 文の形で記述してください。

// function式
var fn = function() { ... };

// function 文
function fn() { ... }

以下は Help コマンドの使用例です。

Module名やClass名で検索

以下のいずれかのコマンドで MyExample の情報を表示します

$ MyExample.help

$ "MyExample".help

$ Help(MyExample)

$ Help("MyExample")

    function MyExample(value) { // @arg String = "" - comment
    //{@dev
        $valid($type(value, "String|omit"), MyExample, "value");
    //}@dev

        this._value = value || "";
    }

    ▶ Google Search( MyExample ):
        http://www.google.com/search?lr=lang_ja&q=MyExample
    ▶ WebModule Reference:
        https://github.com/uupaa/MyExample.js/wiki/MyExample#

Method名で検索

以下のいずれかのコマンドで MyExample.prototype.concat の情報を表示します。

Help("MyExample#concat") は Help("MyExample.prototype.concat") の prototype を # で省略したものです。

$ MyExample.prototype.concat.help

$ Help(MyExample.prototype.concat)

$ Help("MyExample#concat")

$ Help("MyExample.prototype.concat")

    function MyExample_concat(a) { // @arg String
                                   // @ret String
    //{@dev
        $valid($type(a, "String"), MyExample, "a");
    //}@dev

        return this._value + a;
    }

    ▶ Google Search( MyExample.prototype.concat ):
        http://www.google.com/search?lr=lang_ja&q=MyExample.prototype.concat
    ▶ WebModule Reference:
        https://github.com/uupaa/MyExample.js/wiki/MyExample#wiki-myexampleprototypeconcat

JavaScript のキーワードやネイティブAPIの検索

JavaScript API や、ブラウザが提供している API をキーワードに指定できます。

キーワードが window コンテキストに存在しない場合は Google への検索リンクを表示します。
Array や Object など一般的な JavaScript API なら MDN への検索リンクを表示します。

$ Array.isArray.help

$ Help("Array.isArray")

    function isArray() { [native code] }

    ▶ Google.search( Array.isArray ):
        http://www.google.com/search?lr=lang_ja&ie=UTF-8&oe=UTF-8&q=Array.isArray
    ▶ MDN.search( Array.isArray ):
        http://www.google.com/search?btnI=I%27m+Feeling+Lucky&lr=lang_ja&ie=UTF-8&oe=UTF-8&q=MDN%20Array.isArray