【TypeScript/JavaScript】非推奨（Deprecated）の関数を設定する【JSDoc】

TypeScriptやJavaScriptで非推奨（Deprecated）の関数を設定したい！

概要

今回の記事では、TypeScriptやJavaScriptで非推奨（Deprecated）の関数を設定する手順を掲載する。

仕様書

環境

• typescript 5.2.2

手順書

JSDocの書式でコメントを書くことで非推奨の関数を設定することができる。

/**
 * @deprecated この関数は非推奨です。
 */
function NekoPrpr() {
    console.log("prpr");
}

VSCodeなどのインテリセンス機能を持つエディタだと補完されて表示される。VSCodeだと該当の関数に打ち消し線が引かれる。

まとめ（感想文）

開発期間が長くなると必要になってる感じ。