JSDocで型チェックする - Qiita
JavaScriptでも静的な型が求められるようになりTypeScriptやFlowが使われるようになってきました。 しかし、それらが無かったころのJavaScriptのコードやトランスパイラを使わずに開発している人はいてると思います。 この記事はコードの変更なしでJSDocのみで型検査をする方法を紹介します。 TL;DR JSDocの型定義で型チェックをする TypeScriptのallowJsとcheckJsを使う 必要に応じてd.tsをインストールする JSDocの型定義 TypeScriptやFlowが登場するより前からJSDocは存在します。JavadocやPHPDocのJavaScript版のようなものです。 そのJSDocは型定義が書けるようになっています。 エディタによってはJSDocの型定義で型のチェックを行ってくれることもあります。 JSDocについては@use JSD
valid-jsdoc - ESLint - Pluggable JavaScript Linter
If comments are invalid because of typing mistakes, then documentation will be incomplete. If comments are inconsistent because they are not updated when function definitions are modified, then readers might become confused. Rule Details This rule enforces valid and consistent JSDoc comments. It reports any of the following problems: missing parameter tag: @arg, @argument, or @param inconsistent o
JSDocコメントの有効活用。JavaScriptやTypeScriptのドキュメントを生成する方法 - ICS MEDIA
JSDocコメントの有効活用。JavaScriptやTypeScriptのドキュメントを生成する方法 記事「JavaScriptでJSDocコメントを書くメリットとは」でJSDocコメントの有用性について紹介しました。その中で「APIドキュメントの書き出し」をメリットの1つとして取り上げています。 APIドキュメントの利用用途として以下が挙げられます。 JSライブラリの使い方を参照しやすくするため、APIドキュメントとして公開したい 他の開発チームへモジュールの使い方を説明するために、APIドキュメントを用意したい プロジェクトのJavaScriptコードを使って、形式的な納品物の成果物を作りたい 本記事ではAPIドキュメントの作成方法を解説します。 サンプルの紹介 サンプルをGitHubに用意していますので完成系をご覧ください。サイドバーを使うことで関数や定数などのドキュメントをたどるこ
JavaScriptでJSDocコメントを書くメリットとは – ICS MEDIA
筆者が試したところ、開発環境としてWebStormやVS Codeがとくに優れており、ツールチップにJSDocコメントの情報がすべて表示されました。 ちなみにReactやAngularなどのメジャーなJSライブラリにおいても、そのソースコードではJSDocコメントが使われています (例 : Angular、React)。APIが多岐に渡るJSライブラリを利用するとき、わざわざリファレンスをブラウザで開いたり解説書で調べることなく、コード上で関数の仕様を確認できます。 ▲描画ライブラリCreateJSのAPIを表示したもの JSDocコメントのメリット② APIリファレンスの生成 TypeDoc等のツールを使うことでコードのリファレンスドキュメントを作成できます。こういったJSライブラリのリファレンスはみなさんも一度は見たことがあるのではないでしょうか。 ウェブサイト案件のソースコードでAP
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - teppeis/closure-ts: Generates TypeScript declarations(d.ts) from Closure Library JSDoc annotations
if a JSSpecialPropertyDeclaration has a JSDoc type, use it by rbuckton · Pull Request #15788 · microsoft/TypeScript
