Xml 문자열에서는 C#요약 댓글

StackOverflow https://stackoverflow.com/questions/607094

  •  03-07-2019
  •  | 
  •  

문제

나는 문서화하는 몇 가지 방법을 썼 C#에서 다루는 구문 분석니다.때문에 일부 기술 감금 다른 지역에서 시스템의 이러한 토큰을 필요가 XML 형식의 요소가(즉, <tokenName />).고 싶을 넣어의 형식들을 요약 문은 그 자체.

그러나,이것에서 오류가 발생:심하게 형성되 XML--이름이 시작되었다는 잘못된 문자".거의 모든 종류의 escape 문자열을 사용할 수 있는을 포함하는 XML 내 C#요약 의견이 있으십니까?

도움이 되었습니까?

해결책

사용 표준 XML 벗어나려고 합니다.예를 들어:

<summary>This takes a &lt;token1&gt; and turns it into a &lt;token2&gt;</summary>

그것은 슈퍼하기 쉬운 형식 또는 읽기 코드,하지만 IntelliSense 제대로 unescapes 이고 당신이 바로,읽을 수 있는 것에서 도구 설명을 확인합니다.

다른 팁

사용 CDATA 섹션입니다.예를 들어:

<![CDATA[ <name>Bob</name> ]]>

이것은 더 우아하고 읽기 쉬운 소스에서보다 인코딩에 특수 문자를 엔터티를 참조할 때가 있습니다 조각.

는 경우 XML 을 포함하려는 자체가 포함 CDATA 섹션을 사용할 필요가 여러 CDATA 섹션에 설명된 대로 또 다른 대답이에 Stack Overflow 나 Wikipedia.또는 당신은 항상 사용할 수 있습니다 보통은 엔터티를 참조로 설명한 다른 답변에서 여기입니다.

내가 사용하여 탈출 시퀀스,기 때문에 VisualStudios 도구 설명을 표시하지 않는 것의 안에 CDATA 섹션을 참조하십시오.

무 늦었지만,실제 사용하여, <![CDATA[]]> 숨기는 것이 주석에 컴포넌트입니다.

모두 교체 < 고 > 었을 많이 나를 위해 일(lazy:)).내가 찾는 교체 < 가 &lt; 었을 위해 충분히 상속될 수 없기 때문에 그것이 잘못된 xml 위해 적당한 상속될 분석하는 텍스트로서 귀하의 요약을 차단합니다.

다음 예를 참고하십시오.

/// <summary>
/// Parse the queue process response
/// <para>&lt;?xml version="1.0" encoding="utf-16"?>&lt;result success="True">&lt;entity type="resource" operation="update" />&lt;/result></para>
/// <![CDATA[
/// <?xml version="1.0" encoding="utf-16"?><result success="True"><entity type="resource" operation="update" /></result>
/// ]]></summary>
/// <param name="response"></param>
/// <returns></returns>

상속될 것입니다 이것을 보여:

Parse the queue process response
<?xml version="1.0" encoding="utf-16"?><result success="True"><entity type="resource" operation="update" /></result>
라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top