나는 오늘 C # 주석에서 문자를 이스케이프하는 방법을 모른다는 것을 깨달았습니다. 일반 C # 클래스를 문서화하고 싶지만 <및 >문자 를 이스케이프하는 방법을 모르기 때문에 적절한 예제를 작성할 수 없습니다 . <과 를 사용해야 >합니까? 실제 문서에서 주석을 쉽게 읽을 수 있도록하여 예제 코드를 읽을 수 있도록 코드 문서를 생성 할 필요가 없기 때문에 그런 경우가 마음에 들지 않습니다.
답변
XML 주석에서 문자를 이스케이프해야하는 경우 문자 엔터티를 사용해야하므로 질문에서와 같이로 <이스케이프해야합니다 <.
이스케이프의 대안 CDATA은 동일한 효과를 위해 섹션을 사용하는 것입니다 .
당신이 언급했듯이, 이것은보기 좋은 문서를 생성 할 것이지만 읽기에는 끔찍한 주석이 있습니다.
답변
일반 C # 주석에서는 모든 문자를 사용할 수 있습니다 (로 */주석을 시작한 경우 제외 ). /*주석을로 시작한 경우 개행 문자를 제외하고는 예외 //입니다. XML 주석을 사용하는 경우 CDATA 섹션 을 사용하여 ‘<‘및 ‘>’문자를 포함 할 수 있습니다 .
C #의 XML 주석에 대한 자세한 내용 은 이 MSDN 블로그 문서 를 참조하십시오.
예를 들면
/// <summary>
/// Here is how to use the class: <![CDATA[ <test>Data</test> ]]>
/// </summary>답변
“실제 문서의 주석을 쉽게 읽을 수 있도록하고 싶다”고하셨습니다. 나는 동의한다.
개발자는 자동 생성 된 문서를 숙독하지 않고 대부분의 삶 을 코드에서 보냅니다 . 차트 작성과 같은 타사 라이브러리에는 좋지만 모든 코드로 작업하는 사내 개발에는 적합하지 않습니다. MSFT가 개발자를 더 잘 지원하는 솔루션을 찾지 못했다는 사실에 다소 충격을 받았습니다. 코드를 동적으로 확장 / 축소하는 영역이 있습니다 … 인플레 이스 주석 렌더링 토글 (원시 텍스트와 처리 된 XML 주석 간 또는 원시 텍스트와 처리 된 HTML 주석 간)이없는 이유는 무엇입니까? 메서드 / 클래스 프롤로그 주석 (빨간색 텍스트, 기울임 꼴 등)에 기본 HTML 기능이 있어야하는 것 같습니다. 확실히 IDE는 인라인 주석에 활기를 불어 넣기 위해 약간의 HTML 처리 마법을 사용할 수 있습니다.
내 솔루션 해킹 솔루션 : ‘<‘를 “{“로, ‘> “를”} “로 변경합니다. 특정 예제를 포함하여 일반적인 예제 사용 스타일 주석을 다루는 것 같습니다. 불완전하지만 실용적입니다. 가독성 문제 ( ‘<‘사용시 발생하는 IDE 주석 색상 문제)
답변
C # XML 주석은 XML로 작성되므로 일반적인 XML 이스케이프를 사용합니다.
예를 들면 …
<summary>Here is an escaped <token></summary>답변
이 문제에 대한 살기 좋은 해결책은 단순히 XML 주석에 이스케이프 문자가있는 읽기 어려운 버전과 기존 //주석을 사용하는 읽을 수있는 버전의 두 가지 예를 포함하는 것 입니다.
간단하지만 효과적인.
답변
{…}를 사용하는 것보다 ≤ … ≥ (보다 작거나 같음 기호, 크거나 같음 기호, 유니 코드의 U2264 및 U2265)를 사용하는 것이 좋습니다. 밑줄이 그어진 꺾쇠 괄호처럼 보이지만 여전히 꺾쇠 괄호입니다! 그리고 코드 파일에 몇 바이트 만 추가합니다.
