ReflectionClass::getDocComment()

(PHP 5, PHP 7)

获取文档注释

说明

从一个类中获取文档注释。

本函数还未编写文档，仅有参数列表。

参数

此函数没有参数。

返回值

如果存在则返回文档注释，否则返回FALSE。

范例

Example #1ReflectionClass::getDocComment()例子

以上例程会输出：

string(55) "/** 
* A test class
*
* @param  foo bar
* @return baz
*/"

参见

• ReflectionClass::getName() 获取类名

According to what I can find in the PHP (5.3.2) source code, getDocComment will return the doc comment as the parser found it.
The doc comment (T_DOC_COMMENT) must begin with a /** - that's two asterisks, not one. The comment continues until the first */. A normal multi-line comment /*...*/ (T_COMMENT) does not count as a doc comment.
The doc comment itself includes those five characters, so  will get you what's inside. A call to trim() after is recommended.

You can also get the docblock definitions for the defined methods of a class as such: 

If you're using a bytecode cache like eAccelerator this method will return FALSE even if there is a properly formatted Docblock. It looks like the information required by this method gets stripped out by the bytecode cache.

This code can help you get the contents of a docBlock in array format beginning with the @symbol and ignoring the (*) asterists.
class Home {
  /**
   *This method loads the homepage 
   *@param int $id The user id
   *@throws \Exception If the user id doesn't exist
   *@return void
   */
  public function index( $id)
  {
     #...your code here
   }
}
$object = new Home();
//get the comment string
$comment_string= (new ReflectionClass($object))->getMethod('index')->getdoccomment();
//define the regular expression pattern to use for string matching
$pattern = "#(@[a-zA-Z]+\s*[a-zA-Z0-9, ()_].*)#";
//perform the regular expression on the string provided
preg_match_all($pattern, $comment_string, $matches, PREG_PATTERN_ORDER);
echo "
"; print_r($matches);
//this outputs
Array
(
  [0] => Array
    (
      [0] => @param int $id The user id
      [1] => @throws \Exception If the user id doesn't exist
      [2] => @return void
    )
  [1] => Array
    (
      [0] => @param int $id The user id
      [1] => @throws \Exception If the user id doesn't exist
      [2] => @return void
    )
)
//you can then be able to access the particular string values by index
Note that \ReflectionClass::getDocComment() ignores all other PHP code and all white-space between the last encountered T_DOC_COMMENT and the class/element definition.
The only exceptions appear to be T_NAMESPACE declarations and T_FUNCTION definitions.

yields, despite all the garbage in between:
string(28) "/**
 * After namespace.
  */"
To sum up:
1. If there are multiple doc comments, the last encountered applies.
2. Removing the "After namespace." docblock yields FALSE.
  (The namespace delimits the scope.)
3. Uncommenting the function definition yields FALSE.
  (The doc comment applies to the function instead.)
4. Despite being an own language construct, the "const" constant declaration does not delimit the scope.
5. Any leading and trailing white-space before and after the T_DOC_COMMENT ("/**...*/") is ignored, but the entire string content within (including all white-space) is consumed literally/verbatim.
[PHP 5.4.29]
Please note that doc comments are handled differently than regular comments by PHP and the OpCache.
Doc comments are actually kept by the OpCache and accessible by this reflection API, unless disabled by the "opcache.save_comments" INI directive, see http://php.net/manual/en/opcache.configuration.php#ini.opcache.save-comments
Not only this method can find a document by a given method name of a class, like this
 
But, also, if there is no method document in the defination, and the class extends from some other class, the program will automatically 
try to find document from the parent class., like this: 
 

鹏仔微信 15129739599 鹏仔QQ344225443 鹏仔前端 pjxi.com 共享博客 sharedbk.com