* @module object * Objectを受け取りObjectを返します。 */, /** * @param {string} name - 表示したい名前を指定する。 You seem to be reading articles frequently this month.
/** * @param {number} user.age - ユーザーの年齢。 */, ./srcフォルダに機能別に保存され、module.exportsされる関数の仕様を記述・出力する, you can read useful information later efficiently. * @return {string} - [Bye + name]という形式で戻る。 By following users and tags, you can catch up information on technical fields that you are interested in as a whole, By "stocking" the articles you like, you can search right away. 複数の人で開発を進める場合や、プログラムの規模が大きくなってきた場合に、 コメントの記述が、開発の大きな助けとなります。 さらにそのコメントが、標準化された方法で記述されていると、さらに可読性が高まり、 生産性の向上が期待できます。 * @return {string} - [Hello + name]という形式で戻る。 * @module hello What is going on with this article? * @return {string} result.message - メッセージが返ります。
exports = bye = (name) => {return " Bye " + name;} * @return {Object} result オブジェクトが戻る。 * Helloという文字列を返します。 JSDocは、JavaScriptのソースコードにアノテーションを追加するために使われるマークアップ言語である。JSDocをコメントの中に含めることで、プログラマーは自分が書いたコードのAPIを記述するドキュメントを追加することができる。JSDocをさまざまなツールで処理することで、HTMLやRich Text Formatなどの形式のアクセス可能なドキュメンテーションを自動生成することができる。JSDocは、Apache License 2.0の元にライセンスされている自由ソフトウェアである。 JSDocは、JavaScriptのソースコードにアノテーションを追加するために使われるマークアップ言語である。JSDocをコメントの中に含めることで、プログラマーは自分が書いたコードのAPIを記述するドキュメントを追加することができる。JSDocをさまざまなツールで処理することで、HTMLやRich Text Formatなどの形式のアクセス可能なドキュメンテーションを自動生成することができる。JSDocは、Apache License 2.0の元にライセンスされている自由ソフトウェアである。, JavaScriptをドキュメントするためにJavadocに似た構文を使用した最初期の使用例[要出典]は、1999にリリースされたNetscape/MozillaプロジェクトのRhinoである。これは、Javaで書かれたJavaScriptのランタイムシステムである[1]。, JSDocの構文とセマンティックスは、Javaに書かれるコードのドキュメンティングに使われる、Javadocのスキームに似ている。JSDocがJavadocと異なるのは、JavaScriptの動的な振る舞いを扱うために特化している点である。, * @return {string} この Circle のヒューマンリーダブルな表記。, "Annotating JavaScript for the Closure Compiler", https://ja.wikipedia.org/w/index.php?title=JSDoc&oldid=78335352, メソッドのパラメータをドキュメント化する。波括弧の中にデータ型の名前を書いて、パラメータ名の前に挿入することができる。, 不足しているものや追加可能なもの（something open）をドキュメント化する. * Helloという文字列を返します。 Why do not you register as a user and use Qiita more conveniently? */, /** The one-page guide to Jsdoc: usage, examples, links, snippets, and more. Qiita can be used more conveniently after logging in. * @return {string} result.status - "OK or NG"。
最近はJavaScriptを書くことが多く、「仕様書出せ！」と言われるのでJSDocでの記述・出力メモ。, すると、同じ階層にoutというフォルダが作成される。その中のindex.htmlを見る。 Devhints.io Edit Jsdoc cheatsheet Functions /** * This is a function. Why not register and get more from Qiita? Help us understand the problem. * @param {string} user.name - ユーザの名前。 変え方はひとまずリンクだけ。.
下記のような内容が表示される（味気ない）。, Markdownで説明文を書いて、出力時に指定すれば取り込んでくれるみたい（便利）。, JSではObjectを引数、戻り値に取ることもありますよね。。。下記のように記述するようです。, しかしJSDocの標準テンプレートはなんでこんなに微妙なんだろ。。。せめて左メニューにしてくれたらいいのに。。。 Sign up for free and join this conversation. Qiita can be used more conveniently after logging in. JSDocコメントは関数や変数の宣言の直前に記載します。先頭のアスタリスクを2つ記載し/** ◯◯ */とし、型情報等を@typeや@paramというキーワードとともに記述します。 この仕組みは他の言語でも存在し、Java言語だとJavadoc、ActionScript 3.0だとASDocが知られています。JavaScriptのコーディング規約「Google JavaScript スタイルガイド - 日本語訳」でも、「すべてのファイル、クラス、メソッド、プロパティにJSDocコメントが、適切なタグとデータ型を伴って記されるべきです」と推奨されて … * @param {string} name - 表示したい名前を指定する。 /** * Helloという文字列を返します。 * @module bye * @param {string} name - 表示したい名前を指定する。 * @return {string} - [Bye + name]という形式で戻る。 */ module.
* @param {Object} user - ユーザーオブジェクト * @module bye You need to log in to use this function.