JSDocで複数のプログラムで同じ型などを参照する場合の記法について教えてください。

前提・実現したいこと

Visual Studio Codeを用いてJavaScriptの開発を行っています。
JSDoc記法を用いることで入力支援機能を利用できることを知りました。
JSDoc自体はツールを用いてドキュメント生成用の記法と言うことは存じておりますが、今回は入力支援目的でのみ利用しようと考えています。

JavaScriptを目的別などで複数のファイルに分割しようと考えているのですが、
オブジェクトのメソッドパラメータなど、複数のファイルに同じ型を使うことが多いです。

構造化されたオブジェクトを別ファイルの関数などにパラメータとして渡すなどする場合、複数のファイルに同じ内容のJSDocコメントを記載する必要があるのでしょうか？

例

index.js

javascript
1/**
2 * オブジェクト定義
3 * @typedef {{
4 *  "propA" : number,]
5 *  "propB" : number,
6 *  "propC" : number}} typeHoge
7 */
8import * as imp_A from './scripts/a.js';
9import * as imp_B from './scripts/b.js';
10
11/**
12 * @type {typeHoge}
13 */
14var hoge = {
15    "propA" : 20,
16    "propB" : 30,
17    "propC" : 50
18};
19
20imp_A.myFunc(hoge);
21imp_B.myFunc(hoge);

上記のような場合、./scripts/a.jsやb.jsのmyFuncのパラメータにもtypeHogeの定義をそのまま記載することになりますが、typeHogeの@typedefを別ファイルに記載してインポートするような仕組みは存在しないのでしょうか？
各プログラムファイルにコピペすれば済むと言われればそれまでですが、型の変更をした際にJSDocの変更漏れなどが発生する恐れがあるため、1か所に記載するような機能があれば教えてください。

補足情報

VSCodeのバージョンは1.47.2です。
JSDocに関するプラグインなどは特に入れていませんが、標準機能でなくても別のなどの別の仕組みで入力支援が機能するのであれば導入を検討します。

よろしくお願いします。

行動規範の内容に同意します

回答1件

自己解決

タイトルが分かりづらかったかもしれません。

どうやらjsdocの機能としては別ファイルからのインポートなどはできず、必要に応じてコピペする必要がありそうですね。
また、エディタの補完機能などを最大限利用する場合はTypeScriptに移行するのが手っ取り早いようです。
(TypeScriptには*.d.tsファイルを用いて型定義とプログラム本体を別管理できるようです。）

私のほうは今回の課題については、TypeScriptを学習してそちらに移行することとします。

投稿2020/07/30 23:15

Heles

総合スコア2