構文

@borrows <that namepath> as <this namepath>

概要

@borrows タグを利用すると、ほかのシンボルの文書を文書に追加できます。

関数を参照する方法はいくつかあるものの、同じ文書を 2 か所に複製したくない場合に、このタグは役立ちます。

例

この例では、「trstr」関数に文書がありますが「util.trim」は別の名前を使用した、同じ関数の単なる参照名です。

/**
 * @namespace
 * @borrows trstr as trim
 */
var util = {
    trim: trstr
};

/**
 * Remove whitespace from around a string.
 * @param {string} str
 */
function trstr(str) {
}