PHPコードからコメントを取得する方法

PHPのコードを解析する際に、コメントを取得することは重要な機能の一つです。
コメントには、コードの説明や注意点、TODO事項などが書かれていることがあります。

これらの情報を活用することでコードの理解や保守性の向上につながります。
本記事では、nikic/php-parserライブラリを使用してPHPコードからコメントを取得する方法について解説します。

必要な環境とライブラリ

PHPでコメントを取得するには、以下の環境とライブラリが必要です。

PHP 7.0以上
Composer（PHPのパッケージ管理ツール）
nikic/php-parserライブラリ

nikic/php-parserライブラリは、PHPのコードを解析するための強力なツールです。
このライブラリを使用することで、PHPコードのAST（抽象構文木）を取得し、様々な操作を行うことができます。

Composerのインストールについては、次の記事をご覧ください。

ライブラリのインストール

まず、Composerを使用してnikic/php-parserライブラリをインストールします。
プロジェクトのルートディレクトリで以下のコマンドを実行します。

composer require --dev nikic/php-parser

これにより、nikic/php-parserライブラリがプロジェクトの依存関係として追加されます。
PHP-Parserのインストールは、以下の記事で説明しています。

コメントの取得

nikic/php-parserライブラリを使用してPHPコードからコメントを取得するには、以下の手順を実行します。

PhpParser\Lexer\Emulativeのインスタンスを作成し、字句解析器として使用します。
PhpParser\Parser\Php7のインスタンスを作成し、字句解析器を渡してパーサーを初期化します。
PhpParser\NodeTraverserのインスタンスを作成し、ASTをトラバースするためのトラバーサーを用意します。
PhpParser\NodeVisitorAbstractを継承した無名クラスを作成し、enterNodeメソッドをオーバーライドします。このメソッドでは、各ノードに対してコメントを取得し、$commentsプロパティに格納します。
トラバーサーにノードビジターを追加します。
パーサーを使用してPHPコードをパースし、ASTを取得します。
トラバーサーを使用してASTをトラバースし、コメントを取得します。

以下は、コメントを取得するためのPHPコードの例です。

<?php
require 'vendor/autoload.php';

// コメント取得用の関数
function getComments($code) {
    $lexer = new PhpParser\Lexer\Emulative();
    $parser = new PhpParser\Parser\Php7($lexer);
    $traverser = new PhpParser\NodeTraverser();
    $visitor = new class extends PhpParser\NodeVisitorAbstract {
        public $comments = [];
        public function enterNode(PhpParser\Node $node) {
            $comments = $node->getComments();
            if (!empty($comments)) {
                $this->comments = array_merge($this->comments, $comments);
            }
        }
    };
    $traverser->addVisitor($visitor);
    $ast = $parser->parse($code);
    $traverser->traverse($ast);
    return $visitor->comments;
}

// テスト用のPHPコード
$code = <<<'CODE'
<?php
// これはコメントです
/* これも
   コメントです */
function test() {
    // 関数内のコメント
    echo "Hello, world!";
}
CODE;

// コメントを取得
$comments = getComments($code);

// 取得したコメントを表示
foreach ($comments as $comment) {
    echo $comment->getReformattedText() . "\n";
}

上記のコードでは、getComments関数にPHPコードを渡すことで、そのコード内のコメントを取得しています。
取得したコメントは、PhpParser\Commentオブジェクトの配列として返されます。

各コメントオブジェクトのgetReformattedText()メソッドを呼び出すことで、コメントの文字列を取得できます。