2015-02-05 2 views
1

상당량의 코드가 포함 된 클래스를 제거하려고합니다. 나는 또한 문서화하고 잘 문서화하고 싶다. 불행히도이 모든 작업을 하나의 파일로 수행하면 눈을 혼란스럽게 만듭니다. 그것은 총체적이며 빠른 개발을 위해 불필요한 눈을 잡아 먹기 위해 대량의 텍스트를 만들어냅니다.<include> 태그를 사용하여 Intellisense 툴팁에 포함 된 XML 문서의 내용을 표시하는 방법

<include>은 인텔리 센스 기능을 유지하면서 이것을 달성하는 것이 유망 해 보였다. 즉, XML 문서가 메서드 바로 위에 선언 된 경우와 마찬가지로 포함 된 XML 문서 요약이 툴팁에 표시됩니다.

아마 내가 <include>을 오해했을 수도 있지만 툴팁에 다른 파일에있는 XML 설명서가 포함되지 않았습니다. 여기

은 지금 설정을 얼마나 :

/// <include file='xml_include_tag.xml' path='include/member[@name="Foo"]/*' /> 
private String Foo() 
{ 
    return "Foo"; 
} 

XML 파일은 다음과 같습니다

<include> 

    <member name="Foo"> 
     <summary> 
      Returns "Foo" 
     </summary> 
     <returns></returns> 
    </member> 

</include> 

내가 제공과 함께 달성하기 위해 올바르게을 사용하거나 심지어 수없는 건가요 도구 모음?

미리 감사드립니다.

+0

이것이 내가

태그를 사용하고 그 안에 모든 것을 넣은 이유 중 하나입니다. P – Cameron

+0

@Cameron ditto. 예외 정보와 같은 정보를 별도로 구성하는 것이 좋으며, 발언 등은 매우 유용 할 수 있습니다. 그러나 모든 방법에 대해 xml의 10+ 라인? 약간의 롤 (Lol)이 방법을 포함 시키면 우리는 여러 가지 방법으로 문서를 공유 할 수 있습니다. –

답변

0

설명서는 명확하지 않지만이 기능은 Visual Studio C# 편집기의 IntelliSense (최소한 VS2013)에서 지원되지 않는 것으로 보입니다. 너무 나쁘다, 그것은 유용하게 보인다.

대신 예상되는 XML을 출력하는 프로젝트 속성 (빌드 섹션)의 "XML 문서 파일"옵션에서만 작동하는 것처럼 보입니다.

XML 파일은 XPath 문과 완전히 일치하지 않으므로 일치 시키려면 이라는 래핑 된 루트 요소가 <member> 요소가되어야합니다.

+0

루트 태그를 포함 시켰기 때문에 이상합니다.하지만 저장하면 제거됩니다. 그러나 그것은 XML 파일에 있지만 여전히 운이 있습니다. 나는 또한 이것을 두려워했다. 이것은 출력 문서에만 적용되며 내부 IntelliSense 내부에는 아무 것도 없습니다. –

관련 문제