ReflectionFunctionAbstract::getDocComment

    (PHP 5 >= 5.1.0, PHP 7, PHP 8)

    ReflectionFunctionAbstract::getDocComment — ドキュメントコメントを取得する

    説明

    public ReflectionFunctionAbstract::getDocComment(): string|false

    関数のドキュメントコメントを取得します。

    パラメータ

    この関数にはパラメータはありません。

    戻り値

    ドキュメントコメントが存在する場合はそれを返します。それ以外の場合は false を返します。

    参考

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    8
    jens dot kohl+php at gmail dot com
    12 years ago
    Beware when you try to use the getDocComment() methods with eAccelerator turned on. eAccelerator »optimizes« your code in a way that it removes any comments from your source. So at runtime you're not able to get any comments and therefor getDocComments return false.
    up
    4
    bruno at vault7 dot com
    15 years ago
    In order to retrieve a comment with this method, the comment must be imediately before the class, function or method, start with /** and end with */
    ＋add a note
    To Top