ReflectionClass::getDocComment

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getDocCommentBelgelendirici açıklamaları döndürür

Açıklama

public ReflectionClass::getDocComment(): string|false

Sınıftaki belgelendirici açıklamaları döndürür. Belge açıklamaları /** ile başlar ve ardından bir boşluk gelir. Sınıf tanımının üzerinde çok sayıda belge açıklaması varsa sınıfa en yakın olanı alınır.

Bağımsız Değişkenler

Bu işlevin bağımsız değişkeni yoktur.

Dönen Değerler

Varsa belge açıklamaları, yoksa false döner.

Örnekler

Örnek 1 - ReflectionClass::getDocComment() örneği

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

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

Yukarıdaki örneğin çıktısı:

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

Ayrıca Bakınız