ローカル変数の正しいJSDoc構文は何ですか？このような機能のために

Question

...

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.私の使用例の中には、複数行のコメントが必要なものがあります。

Answer 1

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

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

...など。私は彼らのいずれかにドキュメントを生成させることができませんでした。 JS Docの例全体を通して、彼らはこの種の事柄に対して通常のJSコメントを使用します。

結論として、これには公式のJS Doc構文がありません。

Answer 2

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