단위 테스트 사례에 대한 Java 문서 주석 작성

제 생각에는 단위 테스트 사례 자체가 코드의 문서 역할을합니다. 우리 회사는 단위 테스트 사례 위에 상세한 Java 문서 주석을 작성하기를 원합니다. 그렇게해야합니까? 당신은 그런 의견을 쓰십니까?

내가하는 일은 JAVADOC-comment입니다.

• 클래스는 어떤 클래스가 테스트되는지를 나타냅니다 (해당 주제에 대한 모범 사례에서는 테스트 케이스 이름이 클래스 이름 + "Test"또는 + "TestCase"여야 함). 이는 {@link XXXClass} JAVADOC 주석을 사용하여 수행됩니다.

• 테스트 할 메소드를 나타내는 메소드 ({@link XXXClass # method1}) 때로는 모든 경로를 올바르게 테스트하기 위해 클래스의 한 메소드에 대해 여러 테스트 메소드가 필요합니다. 그것이 일어날 때, 나는 내부에서 테스트중인 경로를 나타내는 하나의 추가 줄을 씁니다 (그러나 나는 한 줄 규칙에서 벗어나지 않습니다)

그 외에도 다른 의견은 없습니다. 다른 곳에서 관심을 갖기 위해 Cobertura 와 같은 코드를 사용하여 예쁜 코드 적용 그래픽을 생성하고 행복하게 만들 수 있습니다 :-)

추가 참고 사항 : 단위 테스트 사례를 언급하고 있습니다. 통합 테스트 사례에 대해 이야기하는 경우 진행 상황을 설명하기 위해 1-2 줄 이상이 필요할 수 있습니다 ...

코드에 대한 문서 요구 사항은이 질문에 대한 답변에서 상당히 완벽하게 다루어집니다. 상사는 코드에 대한 설명을 한 줄씩 영어로 설명하고 싶습니다.

답변에 대한 요약으로 "상황에 따라 다릅니다". 합리적이고 권장되는 경우와 시간 낭비 인 경우가 있습니다.

Javadoc 주석은 별도의 참조 문서에서 추출 및 형식화 할 수 있으며 단위 테스트는 불가능합니다. 또한 단어로 작성하는 내용이 실제 코드와 다를 수 있으며 일반적으로 실제 예상되는 동작을 단어로 설명합니다. 버그를 찾는 방법 중 하나는 문서가 실제 코드와 일치하지 않는 경우 문서를 비교하는 것입니다.

단위 테스트는 문서화가 아니라 테스트를위한 것입니다. 문서로 유닛 테스트를 사용하는 것은 잘못되어 있어서는 안됩니다.