Discussion :

[leonel]

Bonjour,

Je suis à la recherche d'un outil pour générer automatiquement de la doc depuis des fonctions/procédures/packages en PL/SQL, en se basant sur des commentaires ou des tag.
En gros, la même chose que la Javadoc, mais en PL/SQL.

J'ai cherché mais en vain. J'ai vu que les packages fournis par oracle sont commentés en Javadoc, mais je ne vois pas comment faire pour mes packages ...
Je dispose également de Toad.

Quelqu'un a une idée ?

Merci

leo

[orafrance]

je ne pense pas que ça existe

[remi4444]

je ne pense pas que ça existe

Mais ça serait super interressant de se faire une norme pour ça, tiens...

[aline]

je ne pense pas que ça existe

Bonjour à tous,

cela existe. En tout cas, au moins plsql/developper le propose. Aujourd'hui, je ne peux plus m'en passer!
voir cette adresse:
http://www.allroundautomations.nl/products.html
onglet
PL/SQL Developer
=> plug-ins
voir plsqldoc

[leonel]

Bonjour,


merci pour ces réponses. J'ai testé PL/SQL developper avec le plug in de génération de doc, et effectivement c'est pas mal.
Je viens de découvrir également un projet opensource:
http://pldoc.sourceforge.net/
et un plug-in pour Eclipse qui permet de s'en servir avec une interface graphique:
http://plsqleditor.sourceforge.net/

Je teste tout ça et je vous tiens au courant !

Leo

[leonel]

Hello,

Après test, voici un petit retour d'expérience sur la génération automatique de doc sur les procédures/fonctions/packages écrits en PL/SQL, à la manière de la javadoc:

Cas 1: Si on n'utilise pas d'IDE et qu'on veut en acquérir un

Le plus simple est d'utiliser le produit PL/SQL Developper:
http://www.allroundautomations.nl/products.html
le plug in de génération de doc marche bien, et c'est intégré à l'IDE.
Attention cependant, ce n'est pas le seul critère de choix. D'autres éditeurs (Toad, Oracle, SQL developper...) ont aussi des arguments.


Cas 2: Si on utilise déja un IDE et qu'on ne veut pas en acquérir un autre

Je pense que le mieux est d'utiliser PlDoc en ligne de commande (http://pldoc.sourceforge.net/) après avoir enregistré toutes ses procédures/fonctions/packages en fichiers à plat.
Le plugin http://plsqleditor.sourceforge.net/ ne permet pas de naviguer directement dans la base de données, il faut utiliser des fichiers à plat, et il n'y a donc pas d'intérêt.

Autre piste: intégrer pldoc sur le serveur Oracle (c'est du Java) et se faire sa propre procédure de génération de doc baséed sur PlDoc.
C'est sûrement ce que je vais faire.

Cas 3: Si on n'utilise pas d'IDE et qu'on ne veut pas en acquérir un

On retombe sur les Cas 2 !

Merci pour les réponses, je passe le post en "résolu".

Leo

[Titouf]

Bonjour,


merci pour ces réponses. J'ai testé PL/SQL developper avec le plug in de génération de doc, et effectivement c'est pas mal.
Je viens de découvrir également un projet opensource:
http://pldoc.sourceforge.net/
et un plug-in pour Eclipse qui permet de s'en servir avec une interface graphique:
http://plsqleditor.sourceforge.net/

Je teste tout ça et je vous tiens au courant !

Leo

j'ai essayé le PL Doc, je trouve cela pas mal avec l'exemple, mais j'ai l'impression que ça buggue, des fichiers semble-t-il ne sont pas générés.

Des liens ne fonctionnent pas en tout cas.

Qu'en pensez vous?

[leonel]

Salut,

Je n'ai pour l'instant essayé qu'avec un cas assez simple, il est possible que ça ne marche pas toujours super bien.
Le projet a l'air raisonablement actif, tu peux peut être soumettre les problèmes observés pour qu'ils soient corrigés ?
Pour ma part, je ne peux pas aller plus loin pour l'instant, donc quand je pourrais m'y remettre il est probable qu'il existe une nouvelle version.
Sinon, comme je l'ai dit, le mieux est de les aider dans leur projet

Leo