🗯

TypeScriptの型コメントをつける。JSDocを使った効果的な型コメントの書き方

2023/03/18に公開

TypeScript では、JSDoc 形式のコメントを使って型情報を付与することができます。これは、特に JavaScript ファイルを TypeScript に移行する際に役立ちます。以下に、JSDoc コメントで型情報を付与する方法を示します。

1. 関数のパラメータと戻り値に型情報を追加する

関数のパラメータや戻り値に型情報を追加することで、誰もがその関数の使い方をすぐに把握できます。以下の例では、square 関数の入力と出力に型情報を追加しています。

/**
 * 数値を二乗する関数
 * @param num - 二乗する数値
 * @returns - 二乗した結果
 */
function square(num: number): number {
  return num * num;
}

型のプロパティも型情報を持たせることができます。これにより、プロパティの使用方法が明確になり、意図しないデータ操作を防ぐことができます。

/**
 * 人物の型
 * @property name - 人物の名前
 * @property age - 人物の年齢
 */
type Person = {
  name: string;
  age: number;
};