인터페이스 및 구현 클래스가 있고 xml 주석을 넣을 VS intellisense 또는 설명서에서 사용할 XML 주석을 원할 경우? 인터페이스의 메서드 또는 구체적인 클래스 메서드에? 올바른 방법은 무엇입니까?.NET 인터페이스에 대한 적절한 xml 설명
인터페이스를 사용하여 변수를 선언하기 때문에 인터페이스에 입력하는 것이 좋습니다. 그리고 나는 또한 그것의 중복 생각 나는 콘크리트 클래스에 대한 의견을 넣어이 동일한 방법에 대한 다른 문서로 이어질 수 있습니다 참조하십시오.
어떤 아이디어, 조언?
모든 공개 회원에 문서화해야합니다. ISomeInterface.SomeMember를 public void SomeMember으로 구현 한 경우 문서화해야합니다. 한 가지 사실은 독자가 이것을 수업의 일부로 보게 될 것이며, 문서를 읽는 것만으로 (그곳에 없는지 알 수없는) 그들이 그 인터페이스에 정의되어 있음을 알게 될 것입니다. void ISomeInterface.SomeMember으로 구현 된 경우 클래스의 공용 인터페이스의 일부로 볼 수 없으므로 덜 중요합니다.
특정 클래스가 주어진 인터페이스 멤버를 구현 한 방법에 대한 세부 정보를 아는 것도 때로 중요합니다.
반면에, 매우 짧은 설명을하고 사람들에게 인터페이스의 문서에 대한 자세한 내용을 알려주는 것이 합리적 일 수 있습니다.