Javascript avec l'analyse des fichiers phpDocumentor

Question

Je joue avec phpDocumentor récemment et trouvé tout à fait adapté à mes besoins. Je travaille en grande partie avec PHP / HTML / JS / CSS et codebases voudrais phpDocumentor pour analyser mon Javascript (et peut-être CSS) afin de garder tous ensemble.

J'ai réussi à obtenir phpdoc pour analyser les fichiers javascript contenus à travers le code de base - mais il rejette la page de niveau docblock - qui se traduit par ce rejet les différentes balises (voir ci-dessous). J'ai trouvé qu'en ajoutant dans une balise ouverte de PHP (avec un commentaire JavaScript avant lui) en haut du fichier JavaScript, je peux l'obtenir pour l'analyser comme un fichier PHP.

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

Je peux penser à un problème survient si le serveur Web est configuré pour les fichiers de serveur via PHP. Y a-t-il d'autres problèmes tout le monde peut penser? Y at-il une meilleure façon d'y arriver?

Merci

Answer 1

En ce qui concerne les problèmes potentiels, celui qui vient à l'esprit est que, puisque vous êtes « duper » phpDocumentor dans l'analyse syntaxique du docblock et le code JS , vous comptez implicitement sur la tokenizer PHP ( qui est comment phpDocumentor parse code PHP en interne) pour lire avec succès votre code JS et le traiter comme code PHP. Quand cela arrive, je pense que vous aurez de bons résultats ... votre exemple simple fonction devrait probablement réussir. Toutefois, si votre code JS sera pas analyser avec succès sous forme de code PHP, alors je parie phpDocumentor ne verra pas comme un élément de code traçables, et donc il ne figurera pas dans vos documents.

Answer 2

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 y a un outil appelé JSDoc qui est essentiellement la même que celle phpdoc, mais JavaScript.

---

Mise à jour le vendredi 1 mai 2015: -

Il semble que le nouveau lien de projet: -

https://github.com/jsdoc3/jsdoc

Answer 3

Je cherche la même chose. J'ai trouvé JSDoc et PhpDocumentor, mais compte tenu du fait que 1 (ONE) application en tant que « Whole » contient à la fois PHP et JavaScript faisant la base de l'application que je préfère 1 approche de la documentation des projets. Il suce vraiment avoir 2 jeux de documentation, 1 pour php et 1 pour JavaScript. Ce @see ole ou en ligne @link ne fonctionne pas dans le cas de, @see cette autre fonction / classe dans cet autre langauge, par l'intermédiaire d'un autre programme de documentation .... obtenir ma dérive?