나는 올바르게 문서화 된 코드를지지하는 사람이며 가능한 단점을 잘 알고 있습니다 . 그것은이 질문의 범위를 벗어납니다.
Visual Studio에서 IntelliSense를 얼마나 좋아하는지 고려하여 모든 공개 멤버에 대해 XML 주석 을 추가하는 규칙을 따르고 싶습니다.
그러나 중복성에는 한 가지 형태가 있는데, 나와 같은 과도한 논평자도 귀찮게합니다. 예를 들어 List.Exists ()를 사용하십시오 .
/// <summary>
/// Determines whether the List<T> contains elements
/// that match the conditions defined by the specified predicate.
/// </summary>
/// <returns>
/// true if the List<T> contains one or more elements that match the
/// conditions defined by the specified predicate; otherwise, false.
/// </returns>
public bool Exists( Predicate<T> match )
{
...
}
Summary
그리고 returns
기본적으로 같은 일을 말하고있다. 필자는 종종 returns
관점 에서 요약을 작성 하여 returns
문서를 완전히 삭제 합니다.
List에 지정된 조건 자에 의해 정의 된 조건과 일치하는 요소가 포함되어 있으면 true를, 그렇지 않으면 false를 반환합니다.
또한 반환 문서는 IntelliSense에 표시되지 않으므로에 즉시 관련 정보를 작성하십시오 summary
.
- 왜
returns
별도로 문서를 작성해야summary
합니까? - Microsoft가이 표준을 채택한 이유에 대한 정보가 있습니까?