79 votes

De bonnes alternatives à Sandcastle pour générer une documentation de type MSDN

J'utilise Sandcastle depuis 2 ans pour générer la documentation d'une bibliothèque open-source. Mais maintenant, je cherche une alternative, car.. :

  1. Même en utilisant Créateur de fichiers d'aide Sandcastle Sandcastle est trop complexe à mon goût. La génération de la documentation devrait être aussi simple que de cliquer sur un bouton ou un menu dans Visual Studio.
  2. Le projet ne semble plus être maintenu ; la dernière version a été publiée en juin 2010, et il ne semble plus y avoir personne qui travaille dessus. Les bugs ne sont plus corrigés, ce qui est un gros problème pour moi (ma bibliothèque utilise beaucoup les méthodes d'extension, et ce bug gâche tout)
  3. Comme il s'agira d'un projet open-source, les produits commerciaux tels que VSdocman et Document ! X sont hors de question pour moi.

Il y a déjà plusieurs similaire questions sur SO, mais ils sont tous assez vieux, et les alternatives proposées ne répondent pas à mes besoins. NDoc était assez bon, mais il n'est plus maintenu et ne supporte pas les fonctionnalités récentes (méthodes d'extension, propriétés attachées...). Je n'aime pas le style de la documentation produite par Docu et Doxygen, je cherche un outil qui produise une documentation de style MSDN.

Alors, y a-t-il un autre outil que je pourrais utiliser ? Ou suis-je coincé avec Sandcastle ?

7voto

Lex Li Points 18214

Il existe plusieurs produits commerciaux capables de le faire, tels que

http://www.doc-o-matic.com/features.html

Mais personnellement, je pense que vous pourriez envisager le Monodoc,

http://www.mono-project.com/Monodoc

Il est toujours activement utilisé par Mono (MonoTouch/Mono pour Android) et ne finira donc pas comme Sandcastle.

6voto

Peter Arandorenko Points 108

Pour C# : Innovasys Document ! X pour la documentation C#

Documentation de type MSDN. Je suis sûr qu'il existe de nombreuses autres bonnes options, dont le prix dépend.

Exemple (Très belle interface utilisateur)

Studio d'aide : Innovasys HelpStudio 2011

Générateur d'aide multiplateforme. Format multi-sorties. Permet également l'importation.

Aussi :

  1. Avez-vous essayé cet article : Documentation du code source C# et XML
  2. Modifier le style de sortie de Doxygen : Feuille de style Doxygen modifiée

2voto

Jeremy Thompson Points 14428

GhostDoc - par Roland Weigelt et Créateur de fichiers d'aide Sandcastle fonctionnent très bien pour moi.

Une autre alternative est http://www.helixoft.com/vsdocman/overview.html

1voto

Joh Points 1788

ApiStack.net est en version bêta. Il s'agit d'un site web, et non d'un outil autonome permettant de générer des documents autonomes, mais cela ne devrait pas être un problème pour un projet open-source. Il a été conçu pour supporter F#, mais les auteurs affirment qu'il devrait fonctionner pour d'autres langages .net, y compris C#.

Peu de projets exposés sur apistack.net ont une documentation complète à ce jour, voir la bibliothèque centrale de F# pour un exemple intéressant des capacités du site.

1voto

MS Stp Points 1436

Je suis novice en matière de génération de documents pour .Net, mais apparemment, la version complète de Sandcastle April 2012 v2.7.0.0 est sortie et peut être téléchargée à partir du lien suivant,

http://sandcastlestyles.codeplex.com/releases/view/86091

Il est indiqué que cette version corrige tous les bogues connus. Cela vaut donc probablement la peine de l'explorer.

Prograide.com

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.

Powered by:

X