PHP 클래스 lithium\analysis\Docblock

This parser may be used as the basis for a variety of secondary tools, including a reflection-based API generator, a code metrics analyzer, and various other possible use cases.
상속: extends lithium\core\StaticObject
파일 보기 프로젝트 열기: unionofrad/lithium 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$tags array List of supported docblock tags.

공개 메소드들

메소드 설명
comment ( string $comment ) : array Parses a doc block into its major components of description, text and tags.
tags ( string $string ) : array Parses @ docblock tags and their descriptions from a docblock.

보호된 메소드들

메소드 설명
_params ( array $params ) : array Parses @param docblock tags to separate out the parameter type from the description.

메소드 상세

_params() 보호된 정적인 메소드

Parses @param docblock tags to separate out the parameter type from the description.
protected static _params ( array $params ) : array
$params array An array of `@param` tags, as parsed from the `tags()` method.
리턴 array Returns an array where each key is a parameter name, and each value is an associative array containing `'type'` and `'text'` keys.

comment() 공개 정적인 메소드

Parses a doc block into its major components of description, text and tags.
public static comment ( string $comment ) : array
$comment string The doc block string to be parsed
리턴 array An associative array of the parsed comment, whose keys are `description`, `text` and `tags`.

tags() 공개 정적인 메소드

See the $tags property for the list of supported tags.
public static tags ( string $string ) : array
$string string The string to be parsed for tags
리턴 array Returns an array where each docblock tag is a key name, and the corresponding values are either strings (if one of each tag), or arrays (if multiple of the same tag).

프로퍼티 상세

$tags 공개적으로 정적으로 프로퍼티

List of supported docblock tags.
public static array $tags
리턴 array