Orga Chem works

A blogging framework for hackers.

Jsdoc2-template-bootstrap: Fix Bugs

やっと…やっと一息つけた… プラグイン関係のバグがあったので修正。 Readmeにも記載ずみ。

JsDoc2-template-bootstrap: First Release

やっとJsDoc2テンプレートをリリースでけた… とりあえず標準のモノよりは全然かっこいいし、みやすいはず。

コード移動のところはちょっと問題あるけど、次期バージョンはJsDoc3への対応予定。 みたところJsDoc3の標準テンプレートはたいしたことなさそうなので、さっさと対応させてしまおうと思う。

JsDoc3 Tag Reference.JP Draft

JsDoc3 タグリファレンス

とりあえず、 definitions.jsfixtures を読んでタグの詳細を調査してみた。 [] は省略可能、 | はどちらかを指定の意。

@abstract, @virtual
@abstract

抽象クラスであることを示す。

@access
@access [access_specifer]

アクセス修飾子を設定する。 access_specifer には public private protected が指定可能。それぞれ private タグ、 protected タグ、 public タグと記述されている場合と同じ動作。

@alias
@alias name_path

オブジェクトの別名を指定する。

@augments, @extends
@augments type|name_path

親オブジェクト(継承元)を示す。

@author
@author author_name

このオブジェクトのソースコードのプログラマ情報を記載する。

@borrows
@borrows name_path [" as " name_path]

このオブジェクトの借用元のクラスを示す。

@class, @constructor
@class [text]

new 演算子が必要な関数であることを示す。 new 演算子が必要でない場合は function を使用するべき。

@classdesc
@classdesc text

クラスの説明文を示す。

@constant, @const
@constant type [text]

定数オブジェクトであることを示す。

@constructs
@constructs [name_path]

特殊な記法でオブジェクト(クラス)を作成していることを示す。 makeClassklass などの関数によってオブジェクトが作成される場合に設定する。

@copyright
@copyright text

著作権情報を設定する。

@default, @defaultvalue
@default [value]

初期値を示す。 value には文字列・値・真偽値など設定可能。プリミティブな値であったら省略可能。省略時にノンプリミティブオブジェクトである場合は出力されないので注意が必要。

@deprecated
@deprecated [text]

使用しないほうがよい旨を表示する。

@description, @desc
@description text

オブジェクトの説明文を示す。タグが省略されている場合はこのタグだと見なされている。

@enum
@enum [type]

列挙型のオブジェクトであることを示す。メンバの型を指定できる。

@event
@event event_type

イベントを示す。

@example
@example text

コードの例を設定する。

@exception, @throws
@exception type [text]

オブジェクトによって投げられる例外を設定する。

@exports
@exports module_path

名前が保護されたオブジェクトであることを示す。たぶん Closure Compiler などの圧縮・最適化ツールによるオブジェクト名の削除・リネームから保護されていることを示すために使われる。

@external
@external type|name_path

外部の名前空間(ライブラリ・モジュール)の参照を設定する。

@file, @fileoverview, @overview
@file text

ソースコードファイルについての説明を示す。

@fires
@fires name_path

発生するイベントを設定する。

@function, @func, @method
@function [name_path]

このオブジェクトが関数であることを示す。

@global
@global 

このオブジェクトがグローバルオブジェクトであることを示す。

@ignore
@ignore 

最終的な出力には含まれないオブジェクトであることを示す。たぶん Closure Compiler などの圧縮・最適化ツールによる削除・リネームによって使用できなくなることを示すために使われる。

@inner
@inner 

オブジェクトが内部関数であると示す。

@instance
@instance 

オブジェクトがインスタンスであると示す。

@kind
@kind kind

オブジェクトの種類を示す。

@lends
@lends name_path

特殊な構文でクラスが作成される場合において、無面関数のメンバが指定されたクラスのメンバであることを示す。

@license
@license text

ライセンス情報を示す。

@member, @var
@member [type] [text]

オブジェクトがメンバであると示す。

@memberof, @memberof!
@memberof name_path

このオブジェクトの属しているオブジェクトを設定する。

@mixes
@mixes name_path

このオブジェクトのメンバがすべて他のオブジェクトのメンバであることを示す。

@mixin
@mixin 

mix-in継承されたオブジェクトとして示す。

@module
@module module_path

このオブジェクトがモジュールであることを示す。モジュールパスは / 記号区切りで記述する。

@name
@name name_path

オブジェクトの名称を設定する。オブジェクトの名称は通常はJsDocが構文から判断しているが、特殊な構文でうまく名前が設定されない場合に使用する。

@namespace
@namespace [type]

このオブジェクトが名前空間オブジェクトであることを示す。

@param, @arguments, @arg
@param [type] [name] [text]

この関数の引数を設定する。

@private
@private 

このオブジェクトがプライベートメンバであることを示す。

@property, prop
@property [type] [name] [text]

このオブジェクトがプロパティであることを示す。

@protected
@protected 

このオブジェクトがプロテクテッドメンバであることを示す。

@public
@public 

このオブジェクトがパブリックメンバであることを示す。 private タグ、 protected タグ、 inner タグ、 access タグが設定されていない場合は自動的にパブリックメンバとなっている。

@readonly
@readonly 

読込専用のオブジェクトであることを示す。

@requires
@requires module_path

必要なライブラリやモジュールなどを設定する。

@returns, return
@returns [type] [text]

戻り値を設定する。通常はコンストラクタには記述しないのが普通。

@see
@see name_path|uri

他に参照するべきオブジェクトかURIがあるときに設定する。ドキュメントにはそのオブジェクトまたはURIのリンクとして出力される。

@since
@since version

このオブジェクトが有効になったバージョンを設定する。 version. 区切りの数字。

@static
@static static

このメンバが静的メンバであることを示す。通常、JsDocは自動的に静的・動的の判断をする。動作がうまくいかない場合にのみ指定すればよい。

@summary
@summary text

説明の要約を設定する。

@this
@this name_path

this キーワードが示すオブジェクトを設定する。

@todo
@todo text

このオブジェクトについてToDo(やるべき事柄)を設定する。

@tutorial
@tutorial text

チュートリアルを設定する。 exmple タグとの違いはいまいちわからない。

@type
@type type|name_path

オブジェクトの型を設定する。

@typedef
@typedef [type] [name] [text]

複雑なオブジェクトの型を設定する。

@undocumented
@undocumented

このタグのつけられたオブジェクトのコメントは読込まれない。

@variation
@variation variation_number

同名のオブジェクトがある場合の識別番号を指定する。 variation_number は整数。

@version
@version version

バージョン情報を設定する。 version. 区切りの数字。