Génération de documentation unifiée Sandcastle pour les projets C# et Java

Question

J'ai un ensemble de composants connexes qui fournissent essentiellement les mêmes fonctionnalités pour divers environnements 'clients', tels que CLR et Java. Actuellement, je génère ma documentation en utilisant Sandcastle pour les composants CLR et je suis sur le point de démarrer les Java. Je voudrais continuer à générer une documentation unifiée, avec un aspect cohérent sur tous les composants (CLR/Java et tout ce qui va suivre). la documentation ne sera disponible que sur le site, donc je me soucie uniquement du format html, pas de CHM ou d'autres formats.

Est-ce possible? Comme je vois les choses, ce serait possible si je pouvais collecter la documentation Java dans un XML avec le schéma consommé par Sandcastle, afin que Sandcastle génère toute la documentation, pour toutes les plateformes. Ce processus est (en quelque sorte) décrit ici: http://sandcastle.codeplex.com/Thread/View.aspx?ThreadId=32301

Existe-t-il une alternative plus simple, plus simple?

Answer 1

Si j'ai bien compris la question, vous souhaitez que la documentation .NET et Java ait un aspect uniforme. L'option que vous allez utiliser est d'utiliser Sandcastle Builder pour générer de la documentation HTML à partir de la documentation que vous avez en Java.

Je pense que cela pourrait être la mauvaise approche, car Sandcastle trébucherait de trouver les types qui existent dans le Java, même si elle est sortie au format XML attendu par Sandcastle.

Mon approche serait d'écrire un doclet pour votre documentation Java, pour correspondre au style de la documentation de style .NET/Sandcastle/MSDN. Le style HTML Javadoc par défaut est hideux, les documents de style .NET MSDN par défaut sont de loin supérieurs à mon avis, donc correspondant à ceux-ci sera le meilleur moyen. Il y a une richesse de doclets déjà écrite. Je n'ai pas pu en trouver un pour produire du XML (les liens sont incorrects sur le site doclet.com). Un outil IBM le fait par here, qu'il utilise des doclets dont je ne suis pas sûr. Une fois que vous avez le code XML, vous pouvez adapter le XSL que le générateur Sandcastle utilise pour produire le même HTML.

J'espère que cela aide + Je suis sur la bonne voie.

Mise à jour

On dirait que quelqu'un a fait une doclet pour produire la documentation MSDN: ndoclet, ce qui signifie que vous pouvez ignorer le processus de transformation XSL.

Answer 2

J'ai essayé Sandcastle pour mes projets mais c'était trop lent.

Maintenant j'utilise doc-o-matic qui supporte aussi Java.

Answer 3

Le SandcastleDoclet de https://code.google.com/p/sandcastle-presentation/ ressemble à un doclet qui peut générer un fichier XML pour Sandcastle.