파생 클래스에 대한 XML 인라인 설명서의 적절한 사용?

Question

인라인 XML 문서 (세 개의 슬래시 사용 - ///)가 저에게 효과가없는 이유를 이해하는 동안 제 "문제"를 해결하는 방법에 대한 지침을 얻고 싶습니다.

필자에게는 인터페이스와 두 개의 파생 클래스가 있습니다. 파생 클래스 중 하나는 시뮬레이션 용이고 다른 하나는 실제 하드웨어와 통신하기위한 것입니다.

하드웨어 구현은 시뮬레이터가 수행 할 필요가없는 특별한 작업을 수행 할 가능성이 높습니다. 시뮬레이터가 아닌 하드웨어 메소드에 대한 XML 문서가 있습니다. 그러나 메서드 이름 위로 마우스를 가져 가면 XML 문서가 인터페이스와 연결되어 있지 않기 때문에 아마도 툴팁에 설명서가 표시되지 않습니다.

분명히 이해할 수 있습니다. 인터페이스에 대신 내 설명서를 넣고 함께 사용하려고합니다. 나는 아직도 궁금해하지만 ... 다른 사람들은 어떻게이 일을합니까? 툴팁이 모든 유효한 XML 문서를 모으는 마법 같은 방법이 있습니까? 즉, 컴파일러는 파생 클래스가 사용 중인지 알지 못하므로이 인터페이스를 구현하는 모든 클래스에 대해 XML 문서를 표시 할 수있는 방법이 있습니까?

Answer 1

인터페이스로 프로그래밍 중이므로 구현에서 XML 문서를 전달할 방법이 없습니다. 분리는 두 "측면"이 서로에 대해 알지 못함을 의미합니다. 당신이 말했듯이, 당신은 그 인터페이스에 대해 두 가지 다른 구현을 할 수 있습니다. 이 경우, 당신은 갈등을 겪을 것입니다. 두 사람에게는 큰 문제가 아니지만 200 명은 무엇인가? 게다가 인터페이스 사용의 요점은 구현 방법에 신경 쓰지 않는다는 것입니다. 인터페이스 사용을 호출하면 구현이 계약을 따를 것이라는 것을 알고 있습니다. 인터페이스의 XML 주석을 사용하여 계약을 구현하는 것이 아니라 계약을 구현하는 방법을 설명합니다.

나는이 문제에 고통을 느낄 수 있으며 더 나은 해결책이 있는지 확신하지 못합니다.

Answer 2

이 모든 문제가 해결되지는 않지만 GhostDoc은 기본 클래스 설명서를 사용하여 파생 클래스에 문서를 빠르게 삽입 할 수 있습니다. 어쨌든 XML 문서를 작성하면 가치가 있습니다.