Fond de tiroir #1 ~ Générateur de doc javascript monofichier

Si vous êtes un développeur dans l’âme, vous avez déjà eu à faire à cette problématique de la petite idée de projet que vous avez codé en une aprèm puis que vous n’avez jamais eu l’envie le temps de retoucher.

Plus le temps passe et plus le nombre d’idées qui végètent sans but dans votre placard à projet s’accumulent… A la lumière de ce constat, j’ai décidé d’ouvrir une petite rubrique pour partager mes fonds de tiroirs, plusieurs n’en sont qu’aux balbutiements, aussi je les partage sur ce blog avec quelques explications au cas ou quelqu’un souhaiterais les ré-exploiter.

Mon fond de tiroir du jour est un petit fichier php unique permettant de générer une doc minimaliste au format HTML à partir d’un fichier javascript.

Concrètement le PHP parse les commentaires au dessus de chaque fonction javascript et génère une page unique de consultation formatée (nom de la fonction, paramètres, descriptif en commentaire…).

La mise en forme reste volontairement simpliste de manière a pouvoir faire un copier coller sur word ou autres éditeurs répandus n’acceptant pas le javascript/css poussé.

Points forts :

  • Simple d’utilisation (simplement deux variables à configurer)
  • Template html de sortie facile a modifier
  • Mono fichier
  • Pas de prérequis autre que PHP
  • Pas besoin d’avoir respecté les normes de commentaires de documentation

Points faibles:

  • Codé avec les pied
  • Doc générée ultra minimaliste
  • non conforme aux standard de commentaires de docs
  • Créé a la base pour une feuille de plugins jquery donc pas forcement utile/a adapter ailleurs
  • Les méthodes statiques sont uniquement définie pour les plugins jquery

Le fichier PHP est ici pour ceux que ça intéresse :
Télécharger le bousin

Si vous souhaitez l’améliorer / y accéder via git, vous pouvez trouver le dépôt créé par Chouchen ici :

https://github.com/Chouchen/jsdoc

6 réactions au sujet de « Fond de tiroir #1 ~ Générateur de doc javascript monofichier »

  1. jerry wham Réponse

    Salut et merci pour le partage.
    Je ne sais pas si ça me servira mais ça vaut toujours le coup de jeter un oeil même si c’est pour voir un pied ^_^

    Et encore merci pour la bière. J’ai pris en compte tes conseils et j’essaie de les appliquer avant de t’envoyer mes sources pour relecture éventuelle.

    À très vite.

  2. Clément Réponse

    Coucou,

    C’est toujours sympa les fonds de tiroir, ça peut devenir de véritables projets populaires.

    Mais pour cela, eux aussi ont le droit d’avoir un repo :-(
    Sinon, comment on peut participer, nous ?

    Clément

    • Idleman Auteur ArticleRéponse

      Je comprends le besoin, le soucis étant que j’ai pas mal de fond de tiroirs, généralement qui ne font pas plus d’une page chacun, ça parait compliqué de créer et maintenir un dépôt pour chacun de ces fichiers.

      J’ai bien pensé à créer un dépôt général pour y stocker mes fonds de tiroirs dans plusieurs sous dossiers mais ça pose des problèmes pour distinguer chaque fond quand il s’agit de téléchargement et/ou de contribution :).

      Cela dit ceux qui veulent ouvrir des dépôts sur leurs comptes pour y reprendre ces projets ont mon entière bénédiction :).

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Xo ^_^ :siffle: :p :-( :evil: oO :) T_T <3 :D more »