Générer de la documentation MySQL

Menace

Générer de la documentation MySQL


Dans Netbeans, si je place des commentaires au-dessus de toutes mes méthodes:

Exemple de méthode avec commentaire

puis faites un clic droit sur mon projet et cliquez sur générer Javadoc:

Menu contextuel: générer Javadoc

Ce qui est généré est un document HTML contenant l’API avec les commentaires de méthode:

"Détails de la méthode", affichant le nom de la méthode et son commentaire

Ceci est vraiment utile lorsque vous travaillez dans un environnement agile où la transparence est si appréciée.


Je sais que dans MySQL, vous pouvez placer des commentaires de la même manière, pour les tableaux:

Saisie d'un commentaire pour une table MySQL

Pour les procédures stockées:

Commentaire pour une procédure stockée

et pour tous les autres composants de la base de données.

Ma question est, existe-t-il un logiciel compatible avec Windows 7 qui peut faire ce que Netbeans fait à une application Java sauf à une base de données MySQL?

Izzy ♦

Je ne l’ai jamais essayé avec MySQL: HyperSQL a été écrit pour Oracle, mais pourrait valoir la peine d’être essayé.

Menace

@Izzy: Cela devrait être une réponse, sûrement?

Izzy ♦

Étant écrit pour Oracle (et je ne l’ai testé qu’avec cela), je ne savais pas s’il répond à vos exigences. Si vous confirmez que c’est une solution acceptable pour vous et que vous travaillez avec votre code MySQL, j’en ferai avec plaisir une réponse!

Menace

@Izzy: Savez-vous si cela fonctionne avec Windows 7?

Izzy ♦

Il nécessite Python, qui est disponible sur plusieurs plates-formes. Je l’ai utilisé sur diverses machines Linux (SuSE, Ubuntu), mais jamais sur Windows – bien que je ne vois aucune raison spécifique pour laquelle cela ne devrait pas fonctionner là-bas. Comme il est gratuit (et même open-source), pourquoi ne pas simplement l’essayer? Sa configuration est aussi simple que de le déballer et de le changer dans son répertoire, avec quelques ajustements facultatifs du fichier .ini .

Réponses


 Tymric

sqlDoxygen

Doxygen est un outil standard bien connu pour la création de documentation de code source. Malheureusement, il ne prend pas en charge nativement SQL. sqlDoxygen est une branche de Doxygen avec une analyse SQL ajoutée.

Fonctionnalités:

  • Convertit les commentaires en documentation HTML, XML ou LaTeX pour le code source
  • Prend en charge HTML, Markdown et d’autres commandes spéciales dans les commentaires
  • Dispose d’une documentation détaillée

Je ne l’ai utilisé qu’avec C ++ et Fortran, mais je suppose qu’il devrait générer des résultats similaires en SQL. Le référentiel contient également quelques fichiers de test qui indiquent le format à utiliser.

Menace

Savez-vous comment installer sqlDoxygen? J’ai téléchargé doxygen pour win32 et l’ai installé mais je ne sais pas comment y ajouter sqlDoxygen?

Tymric

@ThreaT Je pense que vous pouvez cloner le référentiel git clone [email protected]:paulpster/sqlDoxygen.git , puis utiliser le dossier winbuild pour construire la source. Je vais l’essayer plus tard dans la journée et mettre à jour la réponse avec des instructions

Mawg

Ce n’est pas immédiatement clair – est-ce que cela se connecte à une base de données MySql et génère une sortie à partir de là? Ou est-ce le scan du code source qui manipule une base de données?

Tymric

@Mawg Doxygen scanne le code source pour les blocs de documentation. Il est plus facile de commencer avec le manuel du Doxygen d’origine . Des exemples de fichiers pour sqlDoxygen se trouvent dans le dossier d’exemples . Sinon, cela devrait fonctionner de la même manière que Doxygen

 

#de, #la, documentation, générer, MySQL

 

elle.fr

Laisser un commentaire

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