DocCommentオブジェクトは1つのドックコメントを表し、それをパースした結果を保持します。
このクラスのインスタンスはJSDOC.Symbol#commentプロパティから取得できます。
Represents a documentation comment object.
| 名前空間 | JSDOC |
|---|---|
| 継承関係 | JSDOC.DocComment |
| 定義 | DocComment.js |
他のクラスから継承したメンバを折りたたむ
プライベートメンバを隠す
プライベートメンバを隠す
概要 | コンストラクタ | 定数 | プロパティ | メソッド | イベント | 詳細トップ | ページトップ |
|---|
|
JSDOC.DocComment(comment)
Create a new DocComment. |
| Boolean |
ユーザーがソースに記述したコメントであればtrue、システムが処理のために作成したものであればfalse
|
| String |
オリジナルのドックコメントから"/"と"*"を除去したテキスト
|
| JSDOC.DocTag[] |
ドックコメントをパースして取得したタグ（JSDOC.DocTag）オブジェクトの配列
The tags found in the comment. |
| JSDOC.DocTag[] |
getTag(tagTitle)
このコメントに含まれるタグオブジェクトのうち、指定したタグタイトル（タグ名から"@"を除いたもの）に一致するものの配列を返します。
|
| String |
toString()
このオブジェクトの文字列表現として、ドックコメントテキストを返します。
|
詳細 | コンストラクタ | 定数 | プロパティ | メソッド | イベント | 概要トップ | ページトップ |
|---|
Create a new DocComment. This takes a raw documentation comment, and wraps it in useful accessors.
| 引数 |
|
プロパティ
↑
メソッド
↑
このコメントに含まれるタグオブジェクトのうち、指定したタグタイトル（タグ名から"@"を除いたもの）に一致するものの配列を返します。
Given the title of a tag, returns all tags that have that title.
| 引数 |
| |||
| 戻り値 |
|
Documentation generated by JsDoc Toolkit 2.3.2 (template:aias-frame 1.6.1) on Mon Apr 05 2010 22:07:30 GMT+0900 (JST)