Obtenir le code de test unitaire dans XML Comment [dupliquer]

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

  •  11-07-2019
  •  | 
  •  

Question

    

Cette question a déjà une réponse ici:

    
            
  •              Exemple de code de test unitaire                                      4 réponses                          
    •     
    

J'essaie de commenter une API (.Net) que j'expose à un client. Je le fais en utilisant des commentaires XML et en extrayant via SandCastle.

Tout va bien, mais j'ai un peu peur pour l'API et je pense que le code à partir de ceux-ci serait bien placé dans les balises d'exemple.

Alors, est-ce que quelqu'un connaît un bon moyen d'extraire le code de test unitaire et de le placer dans les balises d'exemple? Ou est-ce que quelqu'un a de meilleures idées?

Bien sûr, je redistribue les tests unitaires avec l'API, mais il serait bon de les avoir dans la documentation.

Était-ce utile?

La solution

J'utilise le générateur de fichiers d'aide NUnit et Sandcastle. Consultez la documentation de Sandcastle Help File Builder sur le composant Code Block.

Voici un exemple de la manière dont je place le code de tests unitaires dans la balise exemple: 

    /// <summary>
    /// Returns a string representation of an object.
    /// </summary>
    /// <returns>Comma separated string.</returns>
    /// <example>
    /// <code source="UnitM.CentrallProcessingLib.Tests\Data\CSVDataRowTests.cs" region="ToString_a" />
    /// </example>
    public override string ToString()
    {
        return this.Data;
    }

Voici un test unitaire référencé (CSVDataRowTests.cs) (il devrait figurer dans la section #region): 

  #region ToString_a

    [Test]
    public void ToString_a()
    {
        CSVDataRow res = new CSVDataRow 
        {
            Data = "1;2;3"
        };

        Assert.AreEqual(res.ToString(), res.Data);
    }

  #endregion

Cordialement.

Autres conseils

Je vois que Jon Skeet a répondu, cela demande du travail: Exemple de code de test unitaire automatiquement Est-ce que quelqu'un est parti et a implémenté ceci? Y a-t-il un moyen plus facile? Cette question concerne l’obtention d’un corps métodique à partir d’un fichier cs: Obtenir le contenu d'une méthode à partir d'un fichier cs

J'ai fait un projet pour faire ceci: http://code.google.com/p/addsourcetodocumentation/

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