Erster Unit-Test-Code in XML Kommentar [Duplikat]

Question

    

Diese Frage bereits eine Antwort hier:

    

        
•              automatisch Unit Test Beispielcode                                      4 Antworten                          
    

    

Ich versuche, eine API (.NET) zu kommentieren, dass ich zu einem Kunden bin auszusetzen. Ich tue dies, indem XML-Kommentare verwenden, und Extrahieren von über Sandcastle.

Das ist alles schön und gut, aber ich für die API habe Unittesting, und dachte, der Code von diesen gut wäre, in dem Beispiel-Tags zu setzen.

So kennt jemand eine gute Möglichkeit, Unit-Test-Code und in dem Beispiel-Tags zu extrahieren? Oder hat jemand eine bessere Idee?

Natürlich umverteilen ich die Unit-Tests mit der API, aber es wäre gut, um sie in der Dokumentation zu haben.

Answer 1

Ich bin mit NUnit und Sandcastle Help Builder Datei. Bitte werfen Sie einen Blick auf Sandcastle Help File Builder-Dokumentation über die Code-Block-Komponente.

Hier ist ein Beispiel, wie ich Unit-Tests Code in dem Beispiel-Tag platzieren:

    /// <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;
    }

Hier ist eine referenzierte Unit-Test (CSVDataRowTests.cs) (es im Inneren des #region Abschnitt sein sollte):

  #region ToString_a

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

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

  #endregion

Mit freundlichen Grüßen.

Answer 2

Ich sehe, dass Jon Skeet Antwort har, dass einige Arbeit erfordert: automatisch Unit Test Beispielcode Hat jemand gegangen und umgesetzt? Gibt es einen einfacheren Weg? Diese Frage bezieht sich auf einen metod Körper aus einer Cs-Datei bekommen: einer Methode Inhalte aus einer Cs-Datei Get

Ich habe ein Projekt, dies zu tun gemacht: http://code.google.com/p/addsourcetodocumentation/