Блог

Я недавно познакомился с Reflection и экспериментировал с ним, особенно getDocComment() , однако, похоже, что он поддерживает только /** */ блоки комментариев.

 /** foobar */
class MyClass{}

$refl = new ReflectionClass('MyClass');

// produces /** foobar */
echo $refl->getDocComment();
  

-Против-

 # foobar
class MyClass{}

$refl = new ReflectionClass('MyClass');

// produces nothing
echo $refl->getDocComment();
  

Разве невозможно зафиксировать это, не прибегая к какой-либо file_get_contents(__FILE__) ерунде?

Согласно ответу dader51, я полагаю, что моим лучшим подходом было бы что-то в этом роде:

 // random comment

#[annotation]

/**
 * another comment with a # hash
 */

#[another annotation]

$annotations
    = array_filter(token_get_all(file_get_contents(__FILE__)), function(amp;$token){
    return (($token[0] == T_COMMENT) amp;amp; ($token = strstr($token[1], '#')));
});

print_r($annotations);
  

Выводит:

 Array
(
    [4] => #[annotation]

    [8] => #[another annotation]

)
  

DocComments отличаются тем, что говорят что-то о том, как должны использоваться ваши классы, по сравнению с обычными комментариями, которые могли бы помочь разработчику в чтении кода. Именно поэтому вместо этого не вызывается метод getComment() .

Конечно, это все синтаксический анализ текста, и кто-то только что сделал выбор в docComments, которые всегда являются многострочными комментариями, но этот выбор, по-видимому, был сделан, и чтение обычных комментариев не относится к категории отражения.

Несколько дней назад я пытался сделать просто you, и вот мой трюк. Вы можете просто использовать внутренний токенизатор php ( http://www.php.net/manual/en/function .token-get-all.php ) , а затем пройдитесь по возвращенному массиву, чтобы выбрать только комментарии, вот пример кода :

 $a = token_get_all(file_get_contents('path/to/your/file.php'));
print_r($a); // display an array of all tokens found in the file file.php
  

Вот список всех токенов, которые распознает php : http://www.php.net/manual/en/tokens.php

И комментарий, который вы получите этим методом, включает в себя (из php.net сайт) :

T_COMMENT : // или #, и /* */ в PHP 5

Надеюсь, это поможет!

AFAIK, чтобы комментарий стал документацией, он должен начинаться с /** даже не со стандартного многострочного комментария.

Комментарий doc, как следует из названия, является комментарием к документации, а не стандартным комментарием, в противном случае, когда вы собираете комментарии для таких приложений, как doxygen, Он попытается задокументировать любой прокомментированный код из testing / debuggung и т.д., Который часто остается позади и не важен для пользователя API.

Как вы можете прочитать здесь в первой заметке, внесенной пользователем:

Комментарий к документу ( T_DOC_COMMENT ) должен начинаться с /** — это две звездочки, а не одна. Комментарий продолжается до первого */ . Обычный многострочный комментарий /*...*/ ( T_COMMENT ) не считается комментарием к документу.

Таким образом, только /** */ блоки выдаются этим методом.

Я не знаю никакого другого метода с php для получения других комментариев с помощью file_get_contents и фильтрации комментариев, например, с помощью regex