DocProject vs Sandcastle - Interface utilisateur graphique pour le générateur de fichiers

StackOverflow https://stackoverflow.com/questions/319632

  •  11-07-2019
  •  | 
  •  

Question

J'ai plusieurs projets C # ainsi que des composants de bibliothèque internes que je tente de documenter ensemble. Sandcastle semble être le lieu idéal pour générer de la documentation à partir de C #. J'aimerais savoir lequel des deux, l’interface utilisateur graphique de DocProject ou de Sandcastle Help Builder est meilleur et prend en charge les fonctionnalités dont j’ai besoin.

Je voudrais ne compiler que chaque projet appartenant à une partie du document, puis l'intégrer ensemble à la fin. (c’est-à-dire les composants de la bibliothèque dans un projet de documentation et chaque projet dans son propre projet de documentation, puis tout ce qui précède dans une racine unique à l’aide du visualiseur Help 2)

Était-ce utile?

La solution

Je peux témoigner de Sandcastle Help File Builder. Cela fonctionne très bien et vous pouvez documenter un nombre illimité d'assemblages dans un projet Sandcastle Help File Builder. En théorie, vous pouvez avoir un projet Builder et générer un document pour chaque projet C #, puis un projet maître Builder qui documente tout.

Autres conseils

Je n’ai pas utilisé DocProject, mais c’est un produit aux capacités comparables à Sandcastle.

J'ai utilisé Sandcastle et je trouve que c'est un outil efficace. Vous avez également besoin du constructeur de fichiers d’aide Sandcastle (SHFB) pour vous offrir un bon frontal, comme d’autres l'ont déjà mentionné. ici. En outre, vous avez besoin de Styles Sandcastle pour les correctifs de couche de présentation du moteur Sandcastle. Bien que ces trois composants aient une nouvelle version mi-2010, je reporte la mise à niveau à la version 2008 en raison d’un défaut de rendu dans Firefox 3.6 (documenté dans l’entrée 2010.09.06 de cette rapport de défaut ).

J'ai documenté en détail mon expérience avec la plate-forme décrivant ce problème et diverses autres dont vous pourriez avoir besoin ou que vous souhaitiez prendre en compte pour produire une documentation soignée et professionnelle. Mon article " Taming Sandcastle: Guide du programmeur .NET pour la documentation de votre code " vient de paraître sur Simple-Talk.com en septembre 2010; vous pourriez économiser un peu de temps, d’efforts et d’agonie: -).

Doc Project produit des documents plus raffinés - quand ils fonctionnent - ce qui n’est pas tout le temps. C'est un produit beaucoup plus floconneux.

Le générateur de fichiers d’aide Sandcastle est solide et fait le travail.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top