【PHP8.x】ReflectionMethod::getDocComment()メソッドの使い方

getDocCommentメソッドは、ReflectionMethodオブジェクトが表す特定のメソッドに記述されたドキュメントコメント（DocComment）の文字列を取得するメソッドです。

PHPのDocコメントは、/** ... */の形式で記述される特別なコメントで、メソッドの目的、引数、返り値、例外などの詳細な情報を開発者が記述するために用いられます。これはIDEでのコード補完支援や、自動的なドキュメント生成ツールなどで広く活用されています。

このgetDocCommentメソッドが属するReflectionMethodクラスは、PHPのリフレクションAPIの一部です。リフレクションAPIは、プログラムの実行中にクラスやメソッド、プロパティといったプログラムの構造に関する情報を動的に調べ、操作することを可能にする強力な機能です。

getDocCommentメソッドは、対象のメソッドにDocコメントが存在する場合、そのコメントの全文字列を返します。もしDocコメントが記述されていない場合は、falseを返します。この機能を利用することで、実行時にメソッドのドキュメント情報をプログラムから動的に参照し、それに基づいて処理を分岐させたり、設定を読み込んだり、あるいはカスタムのドキュメント生成ツールを開発したりすることが可能になります。これにより、より柔軟で高機能なアプリケーションやフレームワークを構築する上で役立ちます。

Copy
1<?php
2
3class MyClass {
4    /**
5     * これは、メソッドに関するドキュメントコメントの例です。
6     *
7     * @param string $name ユーザー名
8     * @return string 挨拶メッセージ
9     */
10    public function greet(string $name): string {
11        return "Hello, " . $name;
12    }
13}
14
15$reflectionMethod = new ReflectionMethod(MyClass::class, 'greet');
16$docComment = $reflectionMethod->getDocComment();

引数なし

引数はありません

string|false

このメソッドは、ReflectionMethodオブジェクトが表すメソッドのドキュメントコメントを文字列として返します。ドキュメントコメントが存在しない場合はfalseを返します。