2012-07-14 9 views
3

클래스의 Func 속성을 반환하고 매개 변수를 문서화하는 데 권장되는 방법은 무엇입니까? 예 : C# Func 속성에 대한 XML 문서를 만드는 데 권장되는 방법은 무엇입니까?

Visual Studio 2010의 Intellisense는 메소드와 마찬가지로 속성에 param 또는 return 태그를 제공하지 않습니다. 그것들은 여전히 ​​사용하기에 가장 적합한 태그일까요?

편집 :

이 나도 단순히 PARAM를 사용하여 태그를 반환 할 수 있도록 그래서 내 생각은 이제 더, 유효한 XML 태그를 사용할 수있는 xml-documentation on msdn의 일부에서 발견 한 요청 이후; 또는 커스텀 태그를 사용하고 적절한 네이밍을 결정할 것인가?

답변

4

코드 설명서에 의존하기보다 코드를 "최종 개발자"에게 친숙하게 만드는 것이 좋습니다. 반환 형식을 친숙한 이름의 대리자로 변경하는 것이 좋습니다. 코드 더 자명 할 것이다, 시작하기

http://msdn.microsoft.com/en-us/library/ms173171(v=vs.100).aspx

. 그런 다음 반환 된 값의 유형을 설명하기보다는 코드 설명서를 사용하여 반환 된 값의 목적을 설명 할 수 있습니다.

+0

나는 이것이 내가 실제로 무엇을하고 있다고 생각한다. 하지만 명확히하기 위해'Func '을'public delegate bool MyFuncType (object MyFirstParam, string [] MySecondParam)'으로 정의 된 델리게이트로 바꾼 것입니다. – Alternator

+0

맞습니다. ! :) –

0

속성은 매개 변수를 사용하지 않으므로 매개 변수를 사용하지 않으므로 일반 매개 변수에는 typeparam을 사용해야합니다. returns 대신 value을 사용하십시오.

+0

'속성은 매개 변수를 사용하지 않으므로 매개 변수를 사용하지 않습니다. '- 그게 맞지만 대리자는 특히'Func' tyoe 속성을 의미합니다 –

+0

그는 Func <>을 속성으로 사용하려고합니다. 이는 alwways가 값을 반환하는 델리게이트의 특정 구현이며 널리 사용됩니다. – kerzek

+0

@kerzek, Morawski; 옳은. 위에 나온 플렘의 대답과 내가 읽은 그 이상의 것들로 판단하십시오. 그 정의에 대해 실제로 명시 적으로 정의 된 위임 및 문서를 사용해야하는 것 같습니다. – Alternator