Open2

[deno] deno docでinterfaceのプロパティにコメントをつける

leviosa42leviosa42

失敗例

失敗例1
/**
 * 基本的なトークンを表すインターフェース。
 * 他のトークンはこのインターフェースを継承する。
+ * @prop {string} category トークンのカテゴリ。大別するための文字列が入る。
+ * @prop {string} data トークンのデータ。スキャンした部分文字列が入る。
 */
export declare interface BasicToken {
  category: string;
  data: string;
}
失敗例2
/**
 * 基本的なトークンを表すインターフェース。
 * 他のトークンはこのインターフェースを継承する。
 */
export declare interface BasicToken {
+ /** @prop {string} category トークンのカテゴリ。大別するための文字列が入る。 */
  category: string;
+ /** @prop {string} data トークンのデータ。スキャンした部分文字列が入る。 */
  data: string;
}


プロパティにコメントがつかない。かなしい

成功例

以下のように、プロパティを宣言している行の上に/** コメント */ の形式で説明を入れる

成功例
/**
 * 基本的なトークンを表すインターフェース。
 * 他のトークンはこのインターフェースを継承する。
 */
export declare interface BasicToken {
+  /** トークンのカテゴリ。大別するための文字列が入る。*/
  category: string;
+  /** トークンのデータ。スキャンした部分文字列が入る。*/
  data: string;
}


コメントがついた!うれしい

leviosa42leviosa42
  • interfaceでなくてもこの問題は起こる?
  • そもそもJSDocの記法あってる?