J'ai vu récemment un certain nombre d'endroits qui proposent une documentation en ligne sur l'API HTML ainsi que des fichiers d'aide téléchargeables (généralement au format .chm).
J'aime beaucoup utiliser les fichiers d'aide .chm, principalement en raison de l'arbre d'indexation sur la gauche.
Quels sont les outils permettant de créer ces types de fichiers ?
Puis-je humblement suggérer d'essayer ImmDoc.NET - un projet simple que j'ai développé il y a quelques temps et récemment publié sur CodePlex. Il est léger, très facile à utiliser et supporte .NET 2.0. Il peut également créer une sortie CHM.
La partie générale :
La plupart des outils de génération de documentation d'API ont une préférence pour certains systèmes de développement et certains langages (qu'ils doivent être capables d'analyser), et vous n'avez pas de préférence.
La sous-question de l'écriture :
La plupart des projets déjà nommés ne génèrent que des projets html + HHP, et ont besoin du compilateur MS HTMLHELP1 (de l'atelier htmlhelp) pour compiler, ce qui est un problème sous Linux. On peut essayer Wine, mais surtout sur les serveurs multifonctionnels, c'est souvent mal vu.
Le projet combiné Lazarus/Free Pascal a une compilateur de fichiers d'aide (natif) qui devrait fonctionner sur la plupart des systèmes supportés par FPC (et j'ai essayé sur POWERPC, donc il devrait être largement propre endianess). Assurez-vous d'obtenir au moins la version 2.6.0. J'ai reçu des rapports indiquant qu'il échoue sur les architectures qui lèvent des exceptions en cas de désalignement.
Le compilateur cmdline est appelé chmcmd et il compile les projets Microsoft htmlhelpshop .ini. Il existe également un utilitaire chmls qui liste les fichiers chm. Les deux binaires utilisent une bibliothèque de génération/lecture de CHM qui est principalement utilisée par le système de documentation propre à Free Pascal, fpdoc.
FPDOC est un système de documentation pour FPC/Delphi pour le type "out of source". C'est-à-dire que les documents ne sont pas entrelacés avec les sources mais dans des fichiers (XML) séparés.
Les binaires sont statiques et ceux en 32 bits devraient fonctionner sur n'importe quel système, donc contactez-moi si vous êtes intéressés. Des exemples de CHMs sont ici : http://www.stack.nl/~marcov/doc-chm.zip
Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.
