Je tente de documenter plus complètement nos packages de base de données en tant qu'API. Ce que nous aimerions, c'est quelque chose comme JavaDocs pour PL/SQL. J'ai vu quelques outils là-bas (pldoc, plsqldoc) mais j'aimerais savoir par des gens qui les utilisent comment ils se comparent.Documentation en ligne du package Pl/SQL
Répondre
J'ai utilisé PlDoc et je le trouve très bien. Je n'ai pas utilisé d'autres outils donc je ne peux pas comparer. J'ai trouvé que PlDoc a bien fait les bases. Je voulais des fonctionnalités plus avancées, j'ai donc construit notre propre outil qui a ajouté des extensions à PlDoc pour plus de tags. De plus, je ne fais pas seulement de la documentation avec cela, je génère aussi nos en-têtes de paquet en utilisant des tags PlDoc (par exemple @private).
Je vous recommande d'essayer PlDoc puis de modifier tout ce qui ne répond pas à vos besoins. Il ne prend pas tellement de temps à mettre en place, donc ce n'est pas un investissement de temps énorme pour l'essayer.
J'ai utilisé NaturalDocs depuis quelques années et je l'ai trouvé facile à installer et à utiliser. C'est à peu près comme JavaDocs et supporte plusieurs langues bien que je l'ai seulement utilisé avec PL/SQL. Très configurable même si je n'ai pas trouvé nécessaire de jouer avec ça.
Je n'aurais probablement pas trouvé cet outil particulier sans votre réponse. Bien que très accessible, je pense qu'une solution plus rigide est ce dont notre équipe a besoin. Merci! –