# 初めのあいさつ みなさん、おはようございます。VICE ACADEMIAです。 本日は2月25日の水曜日です。 今日はエビスの日ということで、1890年、 今日この2月25日にエビスビールが初めて発売されたということみたいです。 本日も一日頑張っていきましょう。 # チャンネル紹介 つぞえプログラミング小学生チャンネルでは、プログラミングに興味がある方や学び始めた方に向けて学習のヒントをお伝えしております。 各曜日で話す内容を決めておりますので、興味のある曜日だけでも聞いていただけると嬉しいです。 詳細はプロフィール欄をご確認ください。 # JSDocの書き方 本日は112回目ということで、水曜日なのでガスの回になります。 今日はJS Dockの書き方についてお話ししていきます。 JS Dockというのは、JSとついているので、 JavaScriptは一般的に用いられているドキュメンテーションコメントなんて言ったりしますが、 要は関数の説明をするためのコメントとなります。 詳しくは画像も見れる方はぜひ画像を見てほしいんですけれども、 スラッシュ、アスタリスク、アスタリスクで始まって、 アスタリスク、スラッシュで終わるコメントとなります。 基本的には、ドキュメントのこういう関数だよとか、 この引数は数字型だよとか、この引数は文字列型だよとか、 返り値はこうなっているよみたいな、 そういうのを書いてあげるというイメージを持っていただければよいかなというふうに思います。 もうちょっとだけ詳しく説明していくんですけれども、 どうしても言葉で話すだけだとなかなか難しかったりもするので、 興味のある方はぜひJS Dockと調べていただければ出てくるかなと思いますので、 その辺はよろしくお願いします。 まず一つ目というか、最初は一番シンプルな書き方としては、 ドキュメントの説明だけを書いてあげるというものかなというふうに思います。 例えば、この関数はAとBの和を返す関数だよとか、 そんなのを書いてあげるのが一番シンプルかなというふうに思います。 それに加えて、引数の説明だったりとか、返り値の説明だったりも記述することができます。 ただしいくつかルールがあって、例えば引数の説明をしたいときは、 atmarkparamというのを先頭に書いてあげて、 並括弧で型はナンバーだよとか、ストリングだよとか、そういうのを書いてあげる。 最後というか、その後に名前を書いてあげて、引数名を書いてあげて、 必要であれば引数名の説明も書いてあげるみたいな、ちょっと長いんですけれども、 そんな感じになっております。 リターンも大体似たような感じで、こんな方が帰ってくるよとか、 AとBの和だよみたいなのが書くことができるということですね。 これを書いてあげると何が良いのかというと、 関数を呼び出したときに、四角い枠っていうんですかね、 なんか表示されるんですよね。詳細が表示されます。 例えば、Aは数字型だよとか、この関数はAとBの和を介す関数だよみたいな、 詳細がそこにJSドックを書いてあげると、関数を呼び出したときに、 その詳細が表示してくれるので、これは非常に分かりやすいなというふうに思います。 なので、ちょっとめんどくさいかもしれないんですけれども、 後々楽になると思うので、JSドックをぜひこの機会に書いていただけると良いんじゃないかなというふうに思います。 # 終わりのあいさつ はい、ということで本日はGASのJS DOCK ドキュメンテーションコメントについてのお話でした。 非常にですね、過読性が上がると思いますので、ぜひ今日まで書いてこなかった人はですね、書いていただけると良いんじゃないかなというふうに思います。 はい、最後に少しだけ宣伝です。私、Voicyアカデミーは全都技術系のプラットフォームで伝書付きを販売しております。 このGASもですね、図解GAS基礎文法の教科書というものを出品しておりまして、 もちろんそこにもJS DOCKについての記載がありますので、興味のある方はぜひ概要欄チェックしていただけると幸いでございます。 はい、ということで本日はこれで終わりたいと思います。最後までお聞きいただきありがとうございました。 以上、おっぱいさんアカデミーでした。