XML 문서 : <returns>에 "cref"를 사용하는 경우이 허용 여부가 필요합니까?

Question

나는 등 내 방법을 문서화 GhostDoc을 사용하고 ...하고는 잘 작동하지만이 <returns>이 ...

가 가 가

사람이 내가

즉 일을해야 무엇을 말해 줄 수 것은 그것을 반환하는 경우 기입하지 않습니다 다음 "역할"

<returns>A role object see <see cref = "UserRole" /></returns> 

하거나

<returns>A role object</returns> 

또는

라는 개체 16,

<returns>A role</returns> 

나는 그 조금 너무 정확한되는 소리로 들리 겠지만하지만 난 당신의 단서를 복용 예를 들어 올바른 :-)에게 사용자 이름의 표준 문자열 반환 형식

<returns>The user name</returns> 

<returns>The user name, see <see cref = "system.string" /> </returns> 

Answer 1

을

테이크를 시작하려면 MSDN (example 1, example 2)에서 :

<returns>A <see cref="string" /> that contains the username</returns> 

<returns>An object that contains role information</returns> 

문서상의 발전기 종류를 포함 반환 값은 항상 포함 할 필요가 없습니다. 그러나 이해가된다면 (또는 당신이 그것을 지적하고 싶다면) 그렇게하는 것이 문제가 아니며, 아마 별도의 "see X"문이 아닌 명령문의 흐름에있다.