Discussion :

[pprem]

Un sujet pas vraiment limité à Delphi mais plus général sur la documentation des logiciels, à destination de développeurs ou d'utilisateurs.

Dans l'idée de rendre toujours plus de choses accessibles et compréhensibles (ou en tout cas essayer), je me pose beaucoup de questions sur les logiciels les plus courants pour faire de la documentation, en particulier en lien avec tous les projets et librairies mis en open source sur GitHub ou distribués ailleurs.

Côté doc technique, aide en ligne et utilisateur finaux, il me semble que Help'n Doc reste le plus paramétrable et puissant. J'en avais regardé deux autres (sans me souvenir de leur nom), mais rien comparé à celui-ci. Et comme il est développé en Pascal, il a ma préférence de coeur. Je me relance d'ailleurs dans la rédaction du fameux guide de la formation coronapocalypse 2020 dedans en espérant que cette fois-ci ça aille jusqu'au bout de ce que je voulais obtenir.

Côté codes sources je partirais sur PasDoc.
Il semble simple d'utilisation et ressort tout ce dont on a besoin. Idéal pour générer la doc à partir des codes sources des projets, la compléter puis la mettre en ligne sur les dépôts de code (et non dans leur satané WIKI qui nous coincent chez eux et ne sont pas consultables hors ligne).

Pour les projets web il semblerait que JSDoc et PHPDoc s'en sortent de la même façon. Bien entendu pour le HTML et les CSS ça devient plus compliqué.

Idéalement je prendrais bien un truc qui fait tout (et bien entendu tout seul), mais ça ne semble pas exister.

Quels logiciels utilisez-vous si vous documentez ce que vous faites (pour vous, d'autres développeurs, vos utilisateurs, des clients, ...) ?

[SergioMaster]

Bonjour,

Je te suis sur Help'nDoc et PasDoc, quoique, j'ai toujours quelques problèmes pour les utiliser la faute surtout à l'IDE Delphi.
En effet, sauf à faire les commentaires après que tout soit écrit, ce qui m'énerve le plus ce sont les indications que l'on met au-dessus d'une procédure et qui se retrouve déplacées après la'jout d'une méthode ou une procédure au-dessus de celle-ci

[pprem]

Bonjour,

Je te suis sur Help'nDoc et PasDoc, quoique, j'ai toujours quelques problèmes pour les utiliser la faute surtout à l'IDE Delphi.
En effet, sauf à faire les commentaires après que tout soit écrit, ce qui m'énerve le plus ce sont les indications que l'on met au-dessus d'une procédure et qui se retrouve déplacées après la'jout d'une méthode ou une procédure au-dessus de celle-ci

Ah, oui, tiens, j'ai pas eu ça sur les petits projets sur lesquels je bosse, ça vaudrait le coup de faire une remontée si tu as un cas reproductible, c'est vrai qu'en général je décris ma classe et ajoute ensuite les commentaires, très rare que je laisse Delphi jouer avec la partie interface (hors fiches/DM/frame que je ne commente pas).

[SergioMaster]

D'un autre côté, j'ai aussi écrit un petit programme pour la liste des TODOs permettant d'intégrer quelques tags html (à peaufiner mais assez sympa)