ReflectionClass::getDocComment
PHP Manual
PHP Manual»ReflectionClass»ReflectionClass::getDocComment

ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocCommentGets doc comments

Опис

public function ReflectionClass::getDocComment(): string|false

Gets doc comments from a class. Doc comments start with /**, followed by whitespace. If there are multiple doc comments above the class definition, the one closest to the class will be taken.

Параметри

У цієї функції немає параметрів.

Значення, що повертаються

The doc comment if it exists, otherwise false.

Приклади

Приклад #1 ReflectionClass::getDocComment() example

<?php
/**
 * A test class
 *
 * @param  foo bar
 * @return baz
 */
class TestClass { }

$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment());
?>

Поданий вище приклад виведе:

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

Прогляньте також

To Top