Analyse de fichiers Javascript avec phpDocumentor

Je joue avec phpDocumentor récemment et je l'ai trouvé tout à fait adapté à mes besoins. Je travaille principalement avec les bases de code PHP/HTML/JS/CSS et je voudrais que phpDocumentor analyse mon Javascript (et peut-être CSS) afin de tout garder ensemble. J'ai réussi à obtenir phpdoc pour analyser les fichiers javascript contenus dans le code - mais il rejette le docblock au niveau de la page - ce qui entraîne le rejet des différentes balises (voir ci-dessous). J'ai trouvé qu'en ajoutant une balise PHP ouverte (avec un commentaire JavaScript avant) en haut du fichier JavaScript, je peux l'obtenir pour l'analyser comme un fichier PHP.Analyse de fichiers Javascript avec phpDocumentor

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

Je peux penser à un problème survenant si le serveur Web est configuré sur des fichiers serveur .js via PHP. Y a-t-il d'autres problèmes auxquels on peut penser? Y a-t-il une meilleure façon d'accomplir cela?

Merci

Source

2009-11-22 ncatnow

En ce qui concerne les problèmes potentiels, qui vient à l'esprit est que puisque vous «tromper» phpDocumentor en analysant le docblock et le code JS, vous comptez implicitement sur le tokenizer PHP (qui est comment phpDocumentor analyse le code PHP en interne) pour lire avec succès votre code JS et le traiter comme du code PHP. Quand cela réussira, je pense que vous aurez de bons résultats ... votre exemple de fonction simple devrait probablement réussir. Cependant, si votre code JS va pas analyser avec succès comme du code PHP, alors je parie que phpDocumentor ne le verra pas comme un élément de code documentable, et par conséquent il n'apparaîtra pas dans vos documents.

Source

2009-11-22 13:23:58 ashnazg

je pense qu'il est un peu naïve hypothèse de penser qu'il n'y a pas un outil similaire pour JavaScript.

Il existe un outil appelé JSDoc qui est fondamentalement identique à phpdoc, mais pour JavaScript.

Mise à jour le vendredi 1 mai 2015: -

Il semble que le nouveau lien de projet: -

https://github.com/jsdoc3/jsdoc

Source

2009-11-22 10:51:34

Je ne connaissais pas non plus JSDoc. Je vois le point de @ ncatnow, cependant: Générer la documentation dans un endroit et sur la mise en page, au lieu d'avoir à utiliser deux solutions avec deux configurations dans deux langues différentes, serait lovley. Au moins pour Javascript uniquement fonctionnel cela devrait être possible, ne devrait-il pas? - –

Peut-être essayer Doxygen? C'est similaire à PHPDoc, supporte PHP, et JavaScript aussi. Je ne l'ai pas utilisé moi-même cependant. –

@Jani Hartikainen: Je pense que c'est une supposition un peu naïve de penser que je n'ai pas déjà fait des recherches sur ce sujet. J'ai regardé JSDoc mais c'était un peu exagéré quand tout ce que je voulais c'est d'inclure les quelques fichiers JS dans l'ensemble actuel de docs, avec un simple 'phpdoc', qui me permettrait de définir quelques éléments de todo, de l'empaqueter, et ainsi de suite. Pekka est juste sur l'argent. Comme je l'ai dit, je travaille déjà sur la génération de documents.Je suis curieux de savoir si quelqu'un d'autre l'a déjà fait et de le faire fonctionner d'une façon plus que moi. – ncatnow

Je cherche la même chose. J'ai trouvé JSDoc et PhpDocumentor mais en considérant le fait que 1 (ONE) application en tant que "Whole" contient à la fois PHP et JavaScript faisant la base de l'application, je préférerais 1 approche pour documenter les projets. C'est vraiment nul d'avoir 2 jeux de documentation, 1 pour PHP et 1 pour JavaScript. Que ole @see ou inline @link ne fonctionne pas dans le cas de, @voir cette autre fonction/classe dans cet autre langauge, via un autre programme de documentation .... obtenir ma dérive?

Source

2011-11-08 01:38:47

Analyse de fichiers Javascript avec phpDocumentor

Répondre

Questions connexes