web-dev-qa-db-ja.com

ローカル変数の正しいJSDoc構文は何ですか？

このような機能の場合...

function example() {
  var X = 100;

  ...

  var Y = 'abc';

  ...

  return Z;
}

いくつかのローカル変数の目的を説明する必要があります。このような説明を追加しています...

function example() {
  /**
   * @description - Need to explain the purpose of X here.
   */
  var X = 100;

  ...

  /**
   * @description - Need to explain the purpose of Y here.
   */
  var Y = 'abc';

  ...

  return Z;
}

... JS Doc v3.4.0に取り上げられていないようです。

正しい構文は何ですか？

P.S.私のユースケースのいくつかは、複数行のコメントを必要とします。

javascriptjsdocjsdoc3
14
Kirkland

JS Docsは、「ブロック」内のコメント（クラス、関数など）を無視しているようです。私は試した...

@description
@inner
@instance
@member
@memberof
@name
@summary

...その他。ドキュメントを生成するためにそれらのいずれかを取得できませんでした。 JS Docの例全体を通して、この種のことには通常のJSコメントを使用しています。

これに関する公式のJS Doc構文はありません。

5
Kirkland

私は通常、プロジェクトで以下のコードのようなものを使用します。

function example() {
  /**
   * Need to explain the purpose of X here.
   * @type {number}
   */
  var X = 100;

  ...

  /**
   * Need to explain the purpose of Y here.
   * @type {string}
   */
  var Y = 'abc';

  ...

  return Z;
}
25
mash

一発ギャグ：

  /** @type {string} */
  var Y = 'abc';
1
vitaliytv

私のために働いた最高のもの：

/**
  * @name AssetAutoGenerationOption
  * @type {"all" | "master" | "off"}
  */
export type AssetAutoGenerationOption = "all" | "master" | "off";
0
vljs