Equivalent de ..autodoc pour les autres langages

JS/C/Java/Lua

L'auteur de ce sujet a trouvé une solution à son problème.
Staff
Auteur du sujet

Bonjour,

Je suis en train dans le cadre de mon boulot, de faire un comparatif entre quelques outils de documentation pour qu'on unifie notre doc technique au sein de la boîte.

Actuellement, nous utilisons principalement deux outils doxygen et sphinx plus toute une myriade d'outil adhoc quand on fait des POC (par exemple ldoc pour lua…).

Le principal problème à l'heure actuelle des outils de la seconde catégorie, c'est qu'ils ne possèdent pas de manière native de binding vers la génération de PDF là où doxygen et sphinx l'ont.

A l'heure actuelle, j'étudie sphinx pour comprendre comment mettre en place l'automatisation de la génération de la doc (pour la garder plus facilement à jour). J'ai un POC python forcément mais j'aimerai qu'on puisse montrer que ça marche aussi pour les autres langages.

Seul inconvénient : pour les autres langages, je ne trouve pas d'outil équivalents à autodoc. Enfin pour java, je peux passer par une commande intermédiaire qui génère des fichiers .ReST pour créer mes fichiers de docs avec les bons domaines (java:class, java:constructor…). Seul problème (mineur mais quand même) : comme on a une commande qui génère les fichiers .ReST, ces fichiers ne sont pas customisables (i.e on ne peut pas ajouter des remarques annexes ou bien notre sommaires comme on le fait avec autodoc).

Connaissez vous un outil équivalent à autodoc pour sphinx qui gère au moins un des langages suivants :

  • java
  • lua
  • C
  • delphi
  • php
+0 -0
Staff
Auteur du sujet

En fait je cherche l'équivalent quand on utilise sphinx. Doxygen c'est autre chose. Mais pour faire une vraie comparaison il me faut les deux. Pour l'instant je n'ai commencé à regarder que la partie sphinx. Je verrai pour doxygen plus tard (donc je garde ta suggestion sur le coude même si elle ne répond pas au problème posé).

+0 -0

La problématique n'est pas de générer automatiquement la documentation depuis les sources, avec une sortie PDF ? Avec breathe, tu peut lancer doxygen depuis le conf.py de sphinx, et inclure le résultat depuis les fichiers .rst, fichiers que tu peut personnaliser sans problème.

Mon Github — Tuto Homebrew — Article Julia

+0 -0
Staff

Bah sphinx est a la base fait par et pour python, c'est tout. Depuis que la doc officiel y est passé tous les projets l'utilisent par défaut mais autant c'est très bien quand tu fais uniquement du Python, autant quand tu as des bouts dans d'autres langages c'est pas idéal.

+0 -0
Vous devez être connecté pour pouvoir poster un message.
Connexion

Pas encore inscrit ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte