Автоматически создавать документацию, читая комментарии к функциям (PHP)
Допустим, у меня есть:
class myclass {
/*
* This function, bla bla bla
*/
function myclass()
{
return(true);
}
/*
* This function, bla bla bla
*/
function myfunc1()
{
return(true);
}
/*
* This function, bla bla bla
*/
function myfunc2()
{
return(true);
}
}
Используя get_class_methods(new myclass()); Я могу получить классы.
Теперь мой вопрос таков: могу ли я прочитать комментарии из функции класса в строку?
Так что я могу создавать автоматически сгенерированную документацию.
Решение
Вы не можете получить доступ к комментариям из PHP, если целевой файл включен с include, include_once, require или require_once, потому что php-parser удаляет все комментарии из кода.
Если вам нужно сделать это и вы не хотите использовать PHPDocumentor или Doxygen, но хотите сделать это самостоятельно, вам нужно зарезервировать целевой файл, используя file_get_contents или любой другой метод чтения, и самостоятельно проанализировать этот код, используя регулярные выражения другого метода: ваш выбор (например, с помощью этой библиотеки — https://github.com/nikic/PHP-Parser). И, анализируя код самостоятельно, вы можете получить всю необходимую информацию из комментариев.
Но это не такая простая задача, поэтому я советую использовать PHPDocumentor: P
Другие решения
Других решений пока нет …