He estado jugando con phpDocumentor recientemente y lo encontré bastante adecuado para mis necesidades. Estoy trabajando en gran medida con las bases de código PHP / HTML / JS / CSS y me gustaría que phpDocumentor analice mi Javascript (y quizás CSS) para mantenerlo todo junto.

Me las arreglé para obtener phpdoc para analizar archivos javascript contenidos en toda la base de código, sin embargo, rechaza el docblock a nivel de página, lo que hace que rechace las diversas etiquetas (ver más abajo). Descubrí que al agregar una etiqueta abierta de PHP (con un comentario de JavaScript antes) en la parte superior del archivo JavaScript, puedo hacer que lo analice como un archivo PHP.

// <?php
/**
 * phpdoc goes here
 * @package
 * @todo
 *   - Todo 1
 *   - Todo 2
 */
function javascript(goes, here) {
}

Se me ocurre un problema si el servidor web se configura en los archivos .js del servidor a través de PHP. ¿Hay otros problemas que alguien pueda pensar? ¿Hay una mejor manera de lograr esto?

Gracias

4
ncatnow 22 nov. 2009 a las 13:39

3 respuestas

La mejor respuesta

En cuanto a los posibles problemas, uno que viene a la mente es que, ya que está "engañando" a phpDocumentor para que analice el docblock y el código JS , está contando implícitamente con el tokenizador de PHP (que es cómo phpDocumentor analiza el código PHP internamente) para leer con éxito su código JS y tratarlo como código PHP. Cuando esto tenga éxito, creo que tendrá buenos resultados ... su ejemplo de función simple probablemente debería tener éxito. Sin embargo, si su código JS no se analizará correctamente como código PHP, entonces apuesto a que phpDocumentor no lo verá como un elemento de código documentable y, por lo tanto, no aparecerá en sus documentos.

4
ashnazg 22 nov. 2009 a las 13:23

Estoy buscando la misma cosa. Encontré JSDoc y PhpDocumentor, pero considerando el hecho de que 1 (UNA) aplicación como "Completa" contiene PHP y JavaScript haciendo la base de la aplicación, preferiría 1 enfoque para documentar los proyectos. Realmente apesta tener 2 conjuntos de documentación, 1 para php y 1 para JavaScript. Ese ole @see o inline @link no funciona en el caso de, @see esta otra función / clase en este otro idioma, a través de algún otro programa de documentación ... ¿entiendes?

1
Cory Cullers 8 nov. 2011 a las 01:38

Creo que es un poco ingenuo suponer que no existe una herramienta similar para JavaScript.

Hay una herramienta llamada JSDoc que es básicamente lo mismo que phpdoc, pero para JavaScript.


Actualización viernes 1 de mayo de 2015: -

Parece que el nuevo enlace del proyecto es: -

https://github.com/jsdoc3/jsdoc

8
Omar Tariq 1 may. 2015 a las 09:48