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
JSDoc generates application programming interface (API) documentation from specially-formatted comments in JavaScript code. For example, this is a JSDoc comment for a function: /** * Add two numbers. * @param {number} num1 The first number. * @param {number} num2 The second number. * @returns {number} The sum of the two numbers. */ function add(num1, num2) { return num1 + num2; } If comments are i
JSDocコメントの有効活用。JavaScriptやTypeScriptのドキュメントを生成する方法 - ICS MEDIA
JSDocコメントの有効活用。JavaScriptやTypeScriptのドキュメントを生成する方法 記事「JavaScriptでJSDocコメントを書くメリットとは」でJSDocコメントの有用性について紹介しました。その中で「APIドキュメントの書き出し」をメリットの1つとして取り上げています。 APIドキュメントの利用用途として以下が挙げられます。 JSライブラリの使い方を参照しやすくするため、APIドキュメントとして公開したい 他の開発チームへモジュールの使い方を説明するために、APIドキュメントを用意したい プロジェクトのJavaScriptコードを使って、形式的な納品物の成果物を作りたい 本記事ではAPIドキュメントの作成方法を解説します。 サンプルの紹介 サンプルをGitHubに用意していますので完成系をご覧ください。サイドバーを使うことで関数や定数などのドキュメントをたどるこ
Use JSDoc: @param
Table of Contents Synonyms Overview Examples Names, types, and descriptions Parameters with properties Optional parameters and default values Multiple types and repeatable parameters Callback functions Related Links Synonyms @arg @argument Overview The @param tag provides the name, type, and description of a function parameter. The @param tag requires you to specify the name of the parameter you a
File: Tags Overview — Documentation for yard (0.9.36)
Tags Overview Tags represent meta-data as well as behavioural data that can be added to documentation through the @tag style syntax. As mentioned, there are two basic types of tags in YARD, "meta-data tags" and "behavioural tags", the latter is more often known as "directives". These two tag types can be visually identified by their prefix. Meta-data tags have a @ prefix, while directives have a p
JSDoc: Index
terminal.js: terminal emulator library for browsers and node.js Terminal.js is a rendering engine for vt100-like terminals. It is written from scratch and supports most commonly used escape sequences. Example a simple demo using the colors module: var colors = require('colors'), Terminal = require('./index'); var terminal = new Terminal({columns: 20, rows: 2}); terminal.write("Terminal.js in rainb
Use JSDoc: @type
Table of Contents Syntax Overview Examples Related Links Syntax @type {typeName} Overview The @type tag allows you to provide a type expression identifying the type of value that a symbol may contain, or the type of value returned by a function. You can also include type expressions with many other JSDoc tags, such as the @param tag. A type expression can include the JSDoc namepath to a symbol (fo
enchant.Timeline | JsDoc Reference
Documentation generator: JsDoc Toolkit 2.4.0 Template: Codeview 1.2 Generated on: 2016-0-4 21:23 アニメーションを管理するためのクラス. 操作するノードひとつに対して, 必ずひとつのタイムラインが対応する. タイムラインクラスは, 自身に様々なアクションを追加するメソッドを持っており, これらを使うことで簡潔にアニメーションや様々な操作をすることができる. タイムラインクラスはフレームとタイムのアニメーションができる. Defined in: enchant.js Extends enchant.EventTarget
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - teppeis/closure-ts: Generates TypeScript declarations(d.ts) from Closure Library JSDoc annotations
Microsoft/tsdoc: A doc comment standard for the TypeScript language
if a JSSpecialPropertyDeclaration has a JSDoc type, use it by rbuckton · Pull Request #15788 · microsoft/TypeScript
GitHub - gajus/eslint-plugin-jsdoc: JSDoc specific linting rules for ESLint.
GitHub - syavorsky/comment-parser: Generic JSDoc-like comment parser.
GitHub - kegsay/flow-jsdoc: Use JSDoc to represent Flow annotations
GitHub - yarax/eslint-plugin-typelint: TypeLint is an ESlint plugin for optional static typing in JavaScript, based on JSDoc.
GitHub - jeromeetienne/babel-plugin-jsdoced: babel plugin which use jsdoc to implement strong typing in javascript
JSDoc support by RyanCavanaugh · Pull Request #6024 · microsoft/TypeScript
AngularJSプロジェクトにおけるngdoc・jsdocルール案 · Issue #65 · HAKASHUN/manabi
Release JSDoc 3.4.0 · jsdoc/jsdoc
Class Index | JsDoc Reference