XML 주석으로 단위 테스트 코드 받기 [중복

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

  •  11-07-2019
  •  | 
  •  

문제

이 질문은 이미 여기에 답이 있습니다.

고객에게 노출시키는 API (.NET)에 의견을 말하려고합니다. XML 주석을 사용하고 Sandcastle을 통해 추출 하여이 작업을 수행하고 있습니다.

이것은 모두 훌륭하고 멍청하지만 API에 대한 UnitTesting을 가지고 있으며, 이들의 코드가 예제 태그에 배치하기에 좋을 것이라고 생각했습니다.

그렇다면 단위 테스트 코드를 추출하고 예제 태그에 배치하는 좋은 방법을 아는 사람이 있습니까? 아니면 더 나은 아이디어가 있습니까?

물론 API로 단위 테스트를 재분배하지만 문서에있는 것이 좋습니다.

도움이 되었습니까?

해결책

Nunit 및 Sandcastle 도움말 파일 빌더를 사용하고 있습니다. 코드 블록 구성 요소에 대한 Sandcastle 도움말 파일 빌더 문서를 살펴보십시오.

다음은 예제 태그에 단위 테스트 코드를 배치하는 방법입니다.

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

다음은 참조 단위 테스트 (CSVDATAROWTESTS.CS)입니다 (#REGION 섹션 내부에 있어야 함).

  #region ToString_a

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

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

  #endregion

친애하는.

다른 팁

나는 Jon Skeet Har가 답을 보았습니다. 몇 가지 작업이 필요합니다.자동으로 테스트 예제 코드누구든지 이것을 가서 구현 한 적이 있습니까? 더 쉬운 방법이 있습니까? 이 질문은 CS 파일에서 메토드 본문을 얻는 것에 관한 것입니다.CS 파일에서 메소드의 내용을 가져옵니다

나는 이것을하기위한 프로젝트를 만들었다 :http://code.google.com/p/addsourcetodocumentation/

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top