IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

JavaScript Discussion :

Documentez vos librairies JavaScript comme des pros !


Sujet :

JavaScript

  1. #1
    Membre régulier
    Profil pro
    Inscrit en
    Décembre 2002
    Messages
    93
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Décembre 2002
    Messages : 93
    Points : 114
    Points
    114
    Par défaut Documentez vos librairies JavaScript comme des pros !
    Comme je n'ai pas trouvé, sur le forum, de références faites à un petit logiciel que j'utilise pour générer de la documentation sur mes libraires JavaScript, je vous fais part ici de ma découverte.

    Il s'agit de JSDcoc. JSDoc est un simple script programmé en Perl qui procède de la même manière et avec les mêmes méthodes que JavaDoc, bien connu des développeurs Java. JSDoc génère une documentation d'allure professionnelle en une seule étape qui dure une fraction de seconde.

    La doc est générée à partir du code et des commentaires contenus dans vos fichiers JS. Comme le logiciel est écrit en Perl, il peut être installé sur tous les systèmes d'exploitation qui supportent Perl (Linux, Unix, Windows, MacOS ?)...

    Voici un exemple généré avec JSDoc dans un petit projet récent : Cliquez ici.

    Amusez-vous bien !

  2. #2
    Membre expert Avatar de KiLVaiDeN
    Profil pro
    Inscrit en
    Octobre 2003
    Messages
    2 851
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Octobre 2003
    Messages : 2 851
    Points : 3 481
    Points
    3 481
    Par défaut
    Cool merci du tuyau !

    Petite remarque en passant : il y a juste un petit problème au niveau des dates

    Version: 1.2 (24/30/2005)
    Je plaisante, bien entendu...
    K

  3. #3
    Membre régulier
    Profil pro
    Inscrit en
    Décembre 2002
    Messages
    93
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Décembre 2002
    Messages : 93
    Points : 114
    Points
    114
    Par défaut


    B'en ça alors !!

  4. #4
    Expert éminent

    Avatar de denisC
    Profil pro
    Développeur Java
    Inscrit en
    Février 2005
    Messages
    4 050
    Détails du profil
    Informations personnelles :
    Âge : 44
    Localisation : Canada

    Informations professionnelles :
    Activité : Développeur Java
    Secteur : Service public

    Informations forums :
    Inscription : Février 2005
    Messages : 4 050
    Points : 7 641
    Points
    7 641
    Par défaut Re: Documentez vos librairies JavaScript comme des pros !
    Citation Envoyé par Claude Pelletier
    Comme je n'ai pas trouvé, sur le forum, de références faites à un petit logiciel que j'utilise pour générer de la documentation sur mes libraires JavaScript, je vous fais part ici de ma découverte.
    Merci pour ta contribution, mais pour le principe, je me dois de te montrer qu'on en a déjà parlé : http://www.developpez.net/forums/vie...ighlight=jsdoc.

    Après, tu peux me dire que je fais vraiment du mauvais esprit, parceque cette remarque est vraiment pas très visible , ok, je


  5. #5
    Membre régulier
    Profil pro
    Inscrit en
    Décembre 2002
    Messages
    93
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Décembre 2002
    Messages : 93
    Points : 114
    Points
    114
    Par défaut
    La recherche par mot clef ne m'avait rien donné. Cela dit, un petit rappel de l'existence de ce bel outil n'est pas superflu.

Discussions similaires

  1. Réponses: 5
    Dernier message: 21/08/2014, 13h26
  2. Réponses: 2
    Dernier message: 03/08/2013, 11h30
  3. [Smarty] importer dynamiquement des librairies javascript avec Smarty
    Par anaranjado dans le forum Bibliothèques et frameworks
    Réponses: 2
    Dernier message: 08/04/2010, 14h17
  4. Détecter l'activation de Javascript avec des JSP
    Par TonioLeRital dans le forum Servlets/JSP
    Réponses: 4
    Dernier message: 10/11/2005, 09h31
  5. [JPEG] Traiter des Jpg comme des Bmp : Canvas
    Par Clorish dans le forum Langage
    Réponses: 9
    Dernier message: 20/07/2005, 11h14

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo