Block Tags
@auther name
制作者
@desprecated deprecated-text
非推奨
@useage usage-text
使用方法
@since since-text
どのバージョンから利用可能か
@version version-text
バージョン
@ignore
このタグがあるところはドキュメントとして無視される
@exclude
排除された
@description text
説明
@param [identifier] description
引数
@return description
戻り値
@throws class-name description
例外
@see reference
参照先.{@link}とともに使える・
@see "string"
@see <a href="URL#value">label</a>
@see package.class#member label
Inline Tags
→ブロック要素内のどこにでも書くことができる.
{@docRoot}
ドキュメントとしてのルートへの参照.
{@link package.class#member label}
んでもって,サンプルのコード
Class/Interface example:
/**
* A class representing a window on the screen.
* @description For example:
* <code>
* Window win = new Window(parent);
* win.show();
* </code>
*
* @author Hei Ho
* @version 2.4
* @see de.mirell.math.CQuaternion
* @see de.mirell.as2.lang.Object
*/
class Window extends BaseWindow {
}
Field example:
/**
* The X-coordinate of the component.
*
* @see #getLocation
*/
public var x: Number = 1263732;
Property example:
/**
* Sets the X-coordinate of the component.
* @param Value New x-coordinate from 0-100 pixels
* @see #x
*/
public function set xPosition(Value: Number) {
}
Constructor and Method example:
/**
* Returns the character at the specified index.
* @description An index ranges from <code>0</code>
* to <code>length() - 1</code>.
*
* @param index the index of the desired character.
* @return the desired character.
* @throws StringIndexOutOfRangeException
* if the index is not in the range <code>0</code>
* to <code>length()-1</code>.
* @see String#toString
*/
public function charAt(index: Number): Number {
}
trackback for this entry URL:
http://blog.graffiti-web.org/mt/mt-tb.cgi/209