AddHelp

Help.js を組み込む

GitHub にホストしている自作ライブラリに Help.js を組み込むには、GitHubのリポジトリを設定するコードを埋め込みます。

function Foo() {
}

//{@dev
Foo["repository"] = "https://github.com/GITHUB-USER-NAME/Foo.js";
//}@dev

また、package.json に uupaa.help.js を追加し、
npm install で Help.js がインストールされるように、devDependencies に記述します。

    {
      "devDependencies": {
+       "uupaa.help.js": ""
      }
    }

Function式 と Function文

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

// function式

var fn = function() {

};

// function 文

function fn() {

}

属性

関数の機能と役割を説明するために、以下の属性を使ってマークアップします。
Valid.js の Valid.args 関数は @arg, @var_args, @ret を認識し、自動的にバリデーションコードを生成します。

名前	意味	内容	例
@arg	引数	型	型 = デフォルト値 - コメント
@var_args	可変長引数	引数の型,説明	@var_args Any
@ret	戻り値	戻り値の型,説明	@ret this
@desc	概要	関数の概要	@desc Convert String to Base64String.
@throw	例外	例外のエラー型とエラーメッセージ	@throw Error("invalid args")
@deprecated	廃止予定	廃止予定の機能	@deprecated
その他の属性		認識はしませんが利用は可能です

• 複数の型をとり得る場合は、パイプ(｜)で区切って列挙します。
• あらゆる型を受け取る場合は Any を使います。

@arg の例

• @arg String
• @arg String = ""
• @arg Number|Integer = 0
• @arg Number|Integer = 0 - value
• @arg URLStringArray = [] - [URLString, ...]

DecoratedType

@arg や Valid.type() に指定可能な型は、String や Number などの基本型の他にも、URLString や NumberArray などのように修飾された型を使用できます。
このような型はデコレーションされた型(DecoratedType)と呼びます。

一部の DecoratedType は、Valid.type() や Valid.args() で内容の精査も行われます。

WMURL.js をインストールした環境では、 $type(arg, "URLString")` や $type(arg, "URLStringArray") について内容の精査が行われます。

型の修飾は、String などの基本型で済ませるよりも分かりやすくなるため、多くの場所で使用されています。

型の性質	基本型	修飾表記
URL文字列	String	@arg URLString - "url"
絶対URLの文字列	String	@arg AbsoluteURLString - "http://..."
絶対URLの文字列の配列	String	@arg AbsoluteURLStringArray - ["http://...", ...]
数値の配列	Array	@arg NumberArray - [number, ...]
StringのKeyとNumberのValueをペアにした配列	Array	@arg StringKeyAndNumberValuePairArray - [<key:String, value:Number>, ...]