目次
こんにちは、Benと申します！先月は TypeScript を紹介しました。
でも、 TypeScript はまだ慣れてない方もいるかもしれませんが、
今月は似ている機能を紹介します！それは JS Doc です！
JS Docってなに？
JSDocは、JavaScriptコードに注釈を付け、ドキュメントを生成するためのマークアップ言語です。TypeScriptやJavaScriptの強い型の特徴に慣れていないソフトウェアエンジニアにとって、JSDocは変数、関数、オブジェクトの予想される型を明確に指定する方法を提供します。これにより、コードの可読性とメンテナンス性が向上します。
JS Doc の書き方を見ましょう！
関数の注釈：関数の上に/** */を使用して、関数の目的、パラメータ、戻り値を説明します。例えば：
hover すると、以下のようなメッセージが出てきます。
hover すると、以下のようなメッセージが出てきます。
型定義：複雑な型をカスタム定義し、コード内で再利用することができます。例えば、Student型を定義します：
実践的な意義 JSDocを使用することで、TypeScriptを使用しなくても、JavaScriptで型チェックを利用し、より明確なコード構造を享受することができます。これは、チーム協力とコード品質の向上に特に価値があります。
結論
JSDocはJavaScript開発者にとって重要なツールであり、特に強い型言語に慣れていないエンジニアにとってはそうです。これは、コードの品質とメンテナンス性を向上させるためのシンプルで効果的な方法を提供します。
それでは、また来月で話しましょう！
