내 프로젝트 매니저는 지난 주 클래스의 속성에서 ndoc을 사용할 것을 암시했습니다. 이 일을해야합니까? 이를 수행하는 것이 가장 좋은 방법이라고 생각합니까? 현재 현재 작업하고있는 프로젝트 섹션에 대한 모든 ndoc을 확장 중이지만 얼마나 깊이 들어가야하는지 알지 못합니다. 물론 클래스와 각 메소드에 요약, 매개 변수, 반환 및 설명을 제공했지만 속성에도 ndoc이 필요합니까?속성에 대한 Ndoc 모범 사례?
공개 자산은 외부 세계와 계약을 맺고 있습니다. 문서화해야한다고 생각합니다.
내부 속성은 동일한 어셈블리에서만 사용되므로 문서화하지 않을 수 있습니다.
보호 된 속성은 파생 클래스 (내부 또는 공개)에서만 사용되므로 일부 문서가 필요할 수 있습니다.
개인 속성은 클래스 자체에서만 사용되므로 다시 사용할 수 있습니다.
"문서화하지 않는 것으로 떠나는 것"은 내가 느끼는 방식을 제안합니다. 문서화해야합니다. 동시에 나는 때때로 당신은 확실히 항상 선택한 문서 워크 플로우가 GhostDoc을 사용하는지 여부를 문서화해야 한 가지 또는 다른 ...
이 아마도 당신이 http://programmers.stackexchange.com다른 구성원과 마찬가지로 속성의 의미를 문서화해야합니다. 여기에는 속성의 용도 나 사용할 수있는 것뿐만 아니라 초기 값, 특수한 경우 (예 : 할당되지 않아야하는 값, 예외를 유발하거나 자동으로 다른 값으로 대체되는 값), 가능한 경우 파생 된 클래스에서 속성을 재정의하는 파생물 및 목적을 고려해야합니다.
공공 속성이 요청해야 할 필요가 실현 , NDoc 또는 무엇이든간에. 공용 속성 및 메서드에 대한 XML 주석은 사람들이 사용할 때 Intellisence에 표시되므로 여기에 내용을 추가 할 이유가 없습니다. 속성의 이름이 무엇을하는지 설명하더라도 XML 확인을 위해 XML 주석이 있어야합니다. 많은 코드가 포함되어있어 코드를 사용하는 사람들이 걷지 않고 있음을 알게하는 것이 예의입니다.
개인 소유물은 어느 쪽이든 갈 수 있습니다. 나는 당신이 수업에서해야 할 의견을보기 위해 특별한 모범 사례라고 부르는 것을 주저하고 있습니다. 그 시점에서 당신은 그 사용법을 사소한 것으로 볼 수 있습니다. 즉, 아무도 나 자신을 위해 XML 주석을 사유 재산에 넣었다 고합니다. 6 개월 후에 무엇을하고 있었는지를 기억할 방법이 없으며 추가 할 수있는 구조적 주석을 사용하면 중단 한 부분을 쉽게 파악할 수 있습니다.