Générer le JavaScript de la documentation avec Doxygen

J'utilise le PHP et le JavaScript dans mon projet, que j'ai entièrement code avec netbeans 7.0.1. J'aime vraiment comment netbeans comprend et utilise la JavaDoc de commenter le style, à la fois pour le PHP et le code JS.

Maintenant, je veux générer le code de documentation de PHP ainsi que le code JS. Je sais qu'il ya plusieurs façons de le faire, mais mon objectif principal est d'avoir de la documentation pour les deux parties dans un de la documentation.

De l'expliquer plus loin: Si par exemple, je pourrais utiliser Doxygen et les processus, les fichiers PHP et JsDoc pour traiter les fichiers JS. Le résultat serait, que j'ai maintenant deux docs dans deux dossiers différents, un résultat qui ne me convient pas. Comme je l'ai mentionné, je veux à la fois dans une documentation.

Alors, tout d'abord je suis allé, par l'aide de la doxygen helper js2doxy.pl (http://jsunit.berlios.de/internal.html), mais ce n'était pas assez flexible. Il fonctionne bien à la "normale" des fonctions définies, mais pas avec des anonymes js fonctions.

Après un peu d'essayer beaucoup j'ai pensé pourquoi ne pas modifier le FILE_PATTERNS option de document à traiter .js fichiers, comme la JavaDoc style des commentaires sont presque identiques à ceux utilisés avec PHP. Et bien, le résultat semble prometteur, mais certaines fonctions sont manquantes dans la doc.

Voici des exemples:

/**
 * Definitions for the languages.
 * @memberof Language
 */
Language.Definitions = (function()
{
...
}

Cela fonctionne très bien, je peux voir la documentation. Mais:

**
 * Definitions for the languages
 * @memberof Language
 */
Language.Definitions = (function()
{
    var Translations = {};

    /**
     * Replaces strings.
     * @memberof Language
     * @param string translation Translation string 
     * @param array parameters (optional) List of parameters
     * 
     * @return string replaced string
     */
    function replaceStrings(translation, parameters)
    {
       ...
    }

Dans cet exemple, consultez la documentation de la Langue.Des définitions, mais pas pour replaceStrings(). Avez-vous une idée, ce que je fais de mal? Le même concept est le processus par JsDoc très bien.

Également (partie de la Langue.Les définitions) ...

... 
return {
        /**
         * Initialize translations
         * 
         * @memberof Language
         */
        initTranslations: function()
        {
           ...
        } 
... 
}

... n'est pas indiqué dans la documentation.

Je n'ai pas l'esprit si quelqu'un pouvait me montrer comment faire pour mieux fusionner les deux sorties de doxygen et JsDoc dans une documentation.

Merci beaucoup d'avance!

Salutations!

InformationsquelleAutor John Archer | 2011-09-06