ESDoc - The Good Documentation For JavaScript - クックパッド開発者ブログ

2015/12/22 85 users ESDoc ドキュメンテーションツール JavaSc ツール

2015 - 12 - 22 ESDoc - The Good Documentation For JavaScript こんにちは。会員事業部の 丸山@h13i32maru です *1 。 ソフトウェアのドキュメント(マニュアル)を書くには色々なツールや方法があります。 JavaScriptの場合は JSDoc というドキュメンテーションツールがデファクトスタンダードです。 ですが、JavaSc... 続きを読む

JSDoc Toolkit→JSDoc 3移行ガイド - Technology of DeNA

2013/05/08 61 users フランシスコ Technology of DeNA 渋川

JSDoc Toolkit→JSDoc 3移行ガイド by 渋川よしき 2013/05/08 10:59 on JavaScript ツイート こんにちわ、DeNAサン・フランシスコの渋川と申します。エンジニアブログには初登場です。 JavaScriptのソースコードからAPIドキュメントを生成するツールには何種類かありますが、本語の書籍やウェブサイトでも情報が得られることもあって、JSDocの系... 続きを読む

MOONGIFT - JSDoc - オープンソースによるIT戦略支援 -

2005/12/28 33 users フリーウェア テキストエディタ MOONGIFT SBS ネタ

オープンソース・フリーウェアを毎日紹介するブログ。日々の業務の効率化、新しいサービスのネタ探しにどうぞ。SNS、SBS、CMS、オフィス、画像編集、ユーティリティ、Firefoxアドオン、テキストエディタ、ゲーム…ジャンルは様々。 クリック証券社にてPM/開発者を募集中！(3) インタビューを通じて雰囲気を知る 2010年12月24日 クリック証券社（以下クリック証券）求人記事の第三回になります（... 続きを読む

documentationjs + add-text-to-markdownでREADME.mdのAPIリファレンスを自動更新 | Web Scratch

2019/01/03 27 users Markdown TypeScript README.md

documentationjsはJSDocからドキュメントを生成できるツールで、ES2015以降のコードにも対応しています。 (TypeScriptは対応してないようです) 以前はMarkdownへの出力が難しかったのですが、いつのまにかdocumentation build -f mdでMarkdownでのAPIドキュメントが生成できるようになっていました。 これを使うことで、... 続きを読む

JSDoc 形式のコメントを追記する Vim スクリプトを書きました | Tanablog

2011/05/01 26 users function カーソル 関数 JavaScript 形式

JavaScript の関数に JSDoc 形式のコメントを追加する Vim スクリプトを書きました。 tanabe/WriteJSDocComment.vim – GitHub 実行例 JavaScript の function が書かれている行にカーソルがある状態で :call WriteJSDocComment() を実行すると下記スクリーンショットのように JSDoc 形式のコメントブロッ... 続きを読む

jsdoced.js - test your code with jsdoc

2015/03/18 22 users

jsdoced.js - test your javascript with jsdocJSDOCed Javascript Javascript To Javascript Compiler To Make Javascript Better jsdoced.js will automatically extract jsdoc from your code. Using your jsdoc ... 続きを読む

ESLint の組み込み JSDoc サポートが終了します - Qiita

2018/11/29 18 users Qiita eslint サポート

この記事は公式アナウンス "End-of-Life for Built-in JSDoc Support in ESLint" の翻訳です。 ここ数年で ESLint プロジェクトのサイズとスコープは増大しました。もともとは単一の実行可能パッケージで構成されていましたが、今や複数のパーサーやユーティリティを含む多数のパッケージから構成されるプロジェクトへ成... 続きを読む

2015-11-23のJS: JSDoc 3.4.0、Grunt/Bowerの今後、JavaScriptトレンド - JSer.info

2015/11/24 17 users BOWER Grunt modules jsx ES6

JSer.info #254 - JSDoc 3.4.0がリリースされました。 jsdoc/CHANGES.md at 3.4.0 · jsdoc3/jsdoc パーサーにEspreeを使うことでES6やJSXのコードをパース出来るようになりました。 それに加えてまだ完全ではありませんが、ES6 Classesやmodulesに関するサポートが追加されています。 Use JSDoc: ES 201... 続きを読む

eslint-plugin-import-accessではじめるディレクトリ単位カプセル化

2021/06/27 13 users PACKAGE ディレクトリ 筆者 概念 プラグイン

こんにちは。この記事は筆者が製作したESLint向けプラグイン eslint-plugin-import-accessを紹介する記事です。 このプラグインによりTypeScriptプログラムに擬似的なpackage-private exportの概念が生まれます。JSDocで@packageとアノテートされたexport宣言は、そのファイルが属するディレクトリの外からインポートす... 続きを読む

JSFLのコードヒントを出すためのJsDocを作ったよ。 || ImageLogic -web design, development, photography and more-

2012/02/10 13 users ライトニングトーク DESIGN F-siteセミナー 昨今

ImageLogic-web design, development, photography and more- このエントリーの内容は、先日のF-siteセミナー、Demo2のライトニングトークで話した内容をまとめ直したものです。 世界初の専門書が出版され、友の会なんかも結成された昨今、静かなるブームが感じられるJSFL。でも、このJSFLを書くための開発環境はとっても貧相なのが現状なのです。... 続きを読む

JSDocで型チェックする

2018/08/01 12 users TypeScript トランスパイラ Flow 型定義 ころ

JavaScriptでも静的な型が求められるようになりTypeScriptやFlowが使われるようになってきました。 しかし、それらが無かったころのJavaScriptのコードやトランスパイラを使わずに開発している人はいてると思います。 この記事はコードの変更なしでJSDocのみで型検査をする方法を紹介します。 TL;DR JSDocの型定義で型チ... 続きを読む

JSDocで型を定義してTypeScriptの恩恵を受ける

2021/08/16 8 users TypeScript コーディング 恩恵 インテリセンス 概念

普段からTypeScriptで開発されている方ならば、TypeScriptの恩恵を十分に堪能されていることと思います。 特に私はVS Codeのインテリセンスには頼りっぱなしでこれがなければまともにコーディングができない体になってしまいました。 しかし時には、TypeScriptという概念が存在しない退屈な世界で開発を行わなけらばなら... 続きを読む

もうTypeScriptの補助輪を外そう 明日は//@ts-checkを使う

2021/10/19 5 users TypeScript vim 三輪車 補助輪 前提

VIMで書いている人はいないから、そろそろTypeScript（三輪車の補助輪）を外していこうという話。 Visual Studio Code は下のリンクからインストールできる。これが前提。 TypeScriptを活用したJSプロジェクト JavaScriptファイルにおける //@ts-check を使用してほしい。 JSDocを使ってJSで型ヒントを提供する .jsファ... 続きを読む