2010-12-09 88 views
2

Tout d'abord, j'ai vu Generating Documentation from C# XML Comments et bien d'autres similaires, mais aucun des outils proposés ne fonctionne pour ce dont j'ai besoin.Génération de la documentation C# sans créer de document Xml

J'ai besoin d'un outil gratuit qui peut générer de la documentation (de préférence en HTML) à partir de mon code source sans utiliser le document XML créé par Visual Studio. Le projet a des avertissements en tant qu'erreurs activées et en vérifiant l'option de générer ce fichier xml crée des centaines d'erreurs. En effet, cela exclut 90% des générateurs de documentation C#, y compris Sandcastle, NDoc3, Live Documenter, docu et ImmDoc.

Doxygen fonctionne presque, mais je ne peux pas sembler l'obtenir pour générer la documentation pour les classes génériques surchargées, telles que:

public class MyClass<Foo> 
public class MyClass<Foo, Bar> : MyClass<Foo> 

MyClass dispose d'une documentation, mais MyClass ne fonctionne pas.

Alors la question - est là:

  1. un générateur de documentation que je ne l'ai pas vu qui peut gérer ce cas,
  2. une option de configuration dans l'un des outils que j'ai énumérés qui ferait il fonctionne sans exiger le fichier xml-documentation,
  3. ou même un moyen de désactiver juste les avertissements du compilateur de commentaire sans affecter les avertissements de construction?

Modifier. Une solution au moyen de la méthode n ° 3 consiste à supprimer les avertissements suivants relatifs aux commentaires xml: 1570, 1571, 1572, 1573, 1574, 1580, 1581, 1584, 1587, 1589, 1590, 1591, 1592, 1598, 1710, 1711, 1712, 1723

Répondre

2

Vous pouvez désactiver warning 1591 dans Propriétés du projet, puis générer le code XML.

+1

Bien que cela se débarrasse de la majorité des erreurs, il existe plusieurs autres avertissements de commentaire. Pour que ce soit une bonne solution, je dois désactiver tous les avertissements liés aux commentaires. [Cette page msdn] (http://msdn.microsoft.com/en-us/library/ms228296%28v=VS.90%29.aspx) a été utile pour trouver le reste d'entre eux. Marquage comme solution pour me pointer dans la bonne direction =) –

+0

@GStepanov: Vous devriez juste corriger les autres. Ce sont de vraies erreurs et ne devraient pas être difficiles à réparer. – SLaks

+0

Malheureusement, je ne possède pas le projet; si je l'avais fait, je l'aurais réparé et je ne l'aurais pas posté en premier lieu. –