¿Hay alguna herramienta de análisis PHP DocBlock disponible?

Question

Me gustaría construir algunos sitios de documentación a pequeña escala pero muy personalizados para algunos proyectos. PhpDocumentor es bastante bueno pero es muy pesado. Pensé en intentar modificar las plantillas para eso, pero después de pasar solo un par de minutos investigando, decidí que sería demasiado trabajo.

Idealmente, me gustaría ver algo a lo que pudiera pasar un montón de archivos y hacer que devuelva todos los archivos, clases, propiedades y métodos, junto con sus metadatos, para poder construir algunos simples plantillas basadas en los datos.

¿Hay algún proyecto de analizador sintáctico de DocBlock que me ayude en esta tarea, o estoy atascado reinventando esa rueda?

Answer 1

Puede hacer esto fácilmente a sí mismo con el Reflection API:

/** 
* This is an Example class 
*/ 
class Example 
{ 
    /** 
    * This is an example function 
    */ 
    public function fn() 
    { 
     // void 
    } 
} 

$reflector = new ReflectionClass('Example'); 

// to get the Class DocBlock 
echo $reflector->getDocComment() 

// to get the Method DocBlock 
$reflector->getMethod('fn')->getDocComment(); 

ver este tutorial: http://www.phpriot.com/articles/reflection-api

También hay un PEAR package que puede analizar docblocks.

Answer 2

Parece que desea un analizador de PHP que pueda exportar detalles particulares de lo que se ha analizado.

Nuestro Semantic Designs PHP Front End proporciona un analizador PHP 4/5 completo (a partir de 2016 incluye PHP 7). Analiza el código fuente de PHP, crea árboles de sintaxis abstracta, sellando cada nodo con información de ubicación precisa y los pone a disposición para su uso posterior. Una cosa general que puede hacer es imprimir cualquier subárbol como el texto original.

En su caso, desea escanear los árboles, buscar las clases/métodos/propiedades (como nodos de árbol) e imprimir su texto de origen, junto con la información de ubicación. Creo que eso entregaría exactamente lo que quieres.

Answer 3

Solo para actualizar las respuestas. Es posible que también desee consultar el proyecto phpDocumentor2. Creo que es un analizador PHP DocBlock que se puede extraer fácilmente como una solución independiente.

Answer 4

En caso de que alguien necesita una expresión regular (xdazzsuggested a probar esto y student310 comentó que trabaja para ella/sus necesidades)

if (preg_match_all('/@(\w+)\s+(.*)\r?\n/m', $str, $matches)){ 
    $result = array_combine($matches[1], $matches[2]); 
} 

Ejemplo (Demo):

<?php 
$str =' 
/**  
* @param integer $int An integer 
* @return boolean 
*/ 
'; 
if (preg_match_all('/@(\w+)\s+(.*)\r?\n/m', $str, $matches)){ 
    $result = array_combine($matches[1], $matches[2]); 
} 

var_dump($result); 

Answer 5

Como furgas pointed out, llevo años usando phpDocumentor como un proyecto independiente y funciona bien.

<?php 
$class = new ReflectionClass('MyClass'); 
$phpdoc = new \phpDocumentor\Reflection\DocBlock($class); 

var_dump($phpdoc->getShortDescription()); 
var_dump($phpdoc->getLongDescription()->getContents()); 
var_dump($phpdoc->getTags()); 
var_dump($phpdoc->hasTag('author')); 
var_dump($phpdoc->hasTag('copyright'));