phpDocumentor /ReflectionDocBlock

★ 9,354⑂ 137👁 16⑃ 344● 117▤ 52
PHPMITCreated 2012-04-06
下载:6.0.36.0.3 ↓6.0.32026-03-18
+0
日增长
9,354
stars
137
forks
16
watchers
344
prs
117
issues
52
releases

README

ReflectionDocBlock 
==================

Introduction
------------

The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser
that is 100% compatible with the PHPDoc standard.

With this component, a library can provide support for annotations via DocBlocks
or otherwise retrieve information that is embedded in a DocBlock.

Installation
------------

bash
composer require phpdocumentor/reflection-docblock


Usage
-----

In order to parse the DocBlock one needs a DocBlockFactory that can be
instantiated using its createInstance factory method like this:

php
$factory  = \phpDocumentor\Reflection\DocBlockFactory::createInstance();


Then we can use the create method of the factory to interpret the DocBlock.
Please note that it is also possible to provide a class that has the
getDocComment() method, such as an object of type ReflectionClass, the
create method will read that if it exists.

php
$docComment = create($docComment);


The create method will yield an object of type \phpDocumentor\Reflection\DocBlock
whose methods can be queried:

php
// Contains the summary for this DocBlock
$summary = $docblock-getSummary();

// Contains \phpDocumentor\Reflection\DocBlock\Description object
$description = $docblock-getDescription();

// You can either cast it to string
$description = (string) $docblock-getDescription();

// Or use the render method to get a string representation of the Description.
$description = $docblock-getDescription()-render();


 For more examples it would be best to review the scripts in the /docs/examples folder.

Top issues

Latest release

6.0.3 6.0.3 2026-03-18
What's Changed
 PHP 8.4 fix explicit nullable deprecations by @dasginganinja in https://github.com/phpDocumentor/ReflectionDocBlock/pull/446
 fix: add escaped closing docblock to escaped sequences by @bshaffer in https://github.com/phpDocumentor/ReflectionDocBlock/pull/450
 Fix PHP 8.4 deprecations (see phpDocumentor451) by @danherrero in https://github.com/phpDocumentor/ReflectionDocBlock/pull/452

 New Contributors
 @dasginganinja made their first contribution in https://github.com/phpDocumentor/ReflectionDocBlock/pull/446
 @bshaffer made their first contribution in https://github.com

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON