XML 파생 클래스 또는 인터페이스 구현을위한 소스 코드의 설명

Question

이전 질문과 관련 있습니다. 인터페이스를 정의하면 해당 멤버에 대해 의견을 말합니다. 원문이 더 ​​이상 유효하지 않은 경우를 제외하고는 구현 클래스의 구현에 대해 언급하지 않습니다.

Resharper는 이것으로 문제가 없으며 Visual Studio에서는 경고라고 주장합니다.

중요하게도 상속 된 주석은 함께 작업 할 때 인텔리 센스 (intellisense)를 통해 표시됩니다. 이는 내 유일한 관심사입니다.

이것에 대한 의견이 있습니까?

감사합니다.

Answer 1

코드에 주석을 추가하는 것이 좋습니다. 컴퍼넌트가 비공개 또는 내부 클래스이며 모든 주석이있는 알려진 인터페이스 나 추상 클래스를 통해 항상 노출되는 경우 해당 클래스의 구현에 대해 특정 작업을 주석 처리하면됩니다 (예 : 한 사람이 코드를 보거나, 몇 년 후에 코드로 돌아 간다면). 그렇게하면 코드가하는 일과 그 이유를 이해하는 것이 더 쉬울 것입니다. 프로젝트를 빌드 할 때 XML 문서가 생성되도록 설정 한 경우 Visual Studio는 문서화되지 않은 멤버를 경고합니다. Resharper는 XML 문서 생성을 활성화 할 때 일부 클래스에 대해서도 Resharper 경고를 받지만 Resharper는 공개 된 가시성을 가진 항목에 대해서만 경고합니다. 문서 작업을 줄이려면 공개 클래스와 인터페이스에 먼저 주석을 달고 (특히 제품 라이브러리를 릴리스하는 경우) 공용 시간과 내부/개인 정보를 충분한 시간이 있으면 알려주십시오. 후자에 대해 의견을 말하지 않기로 결정했다면, 코드를 다루는 당신이나 다른 누군가가 논리와 그 이유를 쉽게 이해할 수 있도록하십시오.