Quelles sont les options disponibles pour la documentation de votre code Javascript?

Question

Est-il quelque chose comme dOxygen/Javadoc? Ce qui a tout le monde qui a bien fonctionné?

Answer 1

Le 800-gorille de Javascript documentation est la JSDoc Trousse et son successeur JSDoc 3. La plupart de la documentation est fait avec Javadoc des balises de style et un /** commentaire préfixe.

Exemple:

var MyClass = Class.create(
  /** @lends MyClass# */              // @lends is how you document anonymous classes.
  {
    /**
     * Description of constructor.
     * @class Description of class.   // @class annotation goes anywhere and
     *                                //   describes the whole class.
     * @constructs                    // This is a constructor.
     */
    initialize: function(arg0, arg1) {
      //...
    },

    /** A method. */
    myFunc: function() {},

    /** An instance field. */
    myVar: 123
  }
);

Object.extend(MyClass,
  /** @lends MyClass */
  {
    /** A class method. */
    classFunc: function() {}
  }
);

Answer 2

Comme décrit dans ce lien:

Il existe une autre méthode qui utilise le pseudo-code en java syntaxe du document de javascript..

1. Utiliser un script pour obtenir tous les pseudo-code de .js fichiers et générer des .java fichiers avec le même nom, le script est joint à soufflet nommé builddoc. Ce script obtenez en fait toutes les lignes commencent par ‘///', ‘/*', ‘/ ‘, ‘ * ‘, ‘ /' et ‘//"dans la .fichier java. Ainsi, un fichier javascript comme

   //* package ns;
   /**
   * Foo.
   * @param foo foo.
   */
   var foo=function(foo){}
   //* public void foo(String foo);
   

sera transformé en

package ns;
/**
* Foo.
* @param foo foo.
*/
public void foo(String foo);

Et maintenant, doxygen peut le traiter en java. Vous devez utiliser FILE_PATTERNS = *.de java dans votre doxygen configuration de dire à doxygen pour analyser tous .les fichiers java.

builddoc：

#!/bin/bash

DIRs="./"

if [ $# -ne 0 ]
then
    DIRs=$@
fi

for DIR in $DIRs; do

    JSs=`find $DIR -name "*.js"`

    for JS in $JSs; do
    DOC=`echo $JS|sed 's/\(.*\)\.js/\1.java/g'`;
    if [ $JS -nt $DOC ]; then
        echo "rebuild $DOC"
        grep -e '^\s*\(///\|//\*\|/\*\*\| \* \| \*/\)' $JS | sed 's/^\s*\/\/\*\(.*\)$/\1/g'> $DOC
    fi
done

done