67

<code />JSDocになんらかのタグがあるか知っていますか?ドキュメントに次のようなコードを追加する必要があります。

/**
 * This function does something see example below:
 *
 * var x = foo("test"); //it will show "test" message
 *
 * @param {string} str: string argument that will be shown in message
 */
function foo(str)
{
   alert(str);
}

コメント内のコードをJSDocによってコードとして表示する必要があります(構文が強調表示されていない場合は、少なくとも事前にフォーマットされているか、背景が灰色の何かのように)。

4

6 に答える 6

61

@example http://code.google.com/p/jsdoc-toolkit/wiki/TagExample

/**
 * This function does something see example below:
 * @example
 * var x = foo("test"); //it will show "test" message
 *
 * @param {string} str: string argument that will be shown in message
 */
function foo(str)
{
   alert(str);
}
于 2010-07-13T18:32:31.770 に答える
46

使用する

<pre><code>

....

</code></pre>

これは多くの公式ドキュメントで使用されているものであり、たとえば、いくつかのツールで構文のハイライトを受け取ります

于 2010-06-02T20:33:09.000 に答える
37

Jsdoc3 にはマークダウン プラグインがありますが、デフォルトではオフになっています。./node_modules/jsdoc/conf.json.EXAMPLE...を介してデフォルトの構成ファイルを有効にします

"plugins": [
    "plugins/markdown"
],

...そして、コードを含むドキュメントの優れた構文サポートがあります。Markdown では、3 つのバッククォート ( ```) を使用してコード ブロックを区切ります。元の例を使用するには:

/**
* This function does something see example below:
* ```
* var x = foo("test"); //it will show "test" message
* ```
* @param {string} str: string argument that will be shown in message
*/
于 2015-09-10T15:59:29.430 に答える
6

任意の HTML を JSDoc に入れることができ、それがコピーされます。私が使用するものの例を次に示します。

/** 
 * The ReplaceSlang method replaces the string &quot;hi&quot; with &quot;hello&quot;.
 *   <script language="javascript">
 *     function testFunc() {
 *       alert(ReplaceSlang(prompt("Enter sample argument")));
 *     }
 *   </script>
 *   <input type="button" value="Test" onclick="testFunc()" />
 * @param {String} str The text to transform
 * @return {String}
 */
exports.ReplaceSlang = function(str) {
  return str.replace("hi", "hello");
};

ボタンが要約に含まれていないことを確認するには、その前に文とドット (.) を追加します。

JavaScript ファイルが読み込まれるように、JSDoc の出力に JavaScript ファイルを含める方法を見つける必要があります。(それ以外の場合、コードは JSDoc の出力に javascript として存在しません。そのためのテンプレートを変更できます。JsPlate のドキュメントを参照してください)

于 2010-08-23T17:37:51.507 に答える
4

@exampleの使用はほとんどの場合に機能しますが、HTML の予約文字はリテラルに変換する必要があります。&lt; &gt;そうしないと、HTML がレンダリングされ、コードとして表示されません。

于 2014-05-29T09:09:38.903 に答える