C# 또는 VB 설명서 주석에 굵은 글씨 또는 기울임꼴로 표시됩니까?

C# 또는 VB 설명서 주석에 굵은 글씨 또는 기울임꼴로 표시됩니까?

굵은 글씨나 이탤릭체로 된 설명서 설명을 사용할 수 있는 방법이 있습니까?다음과 같은 것:

/// <summary>Cleanup method. This is <b>recommended</b> way of cleanup.</summary>
public void CleanAll();

사전 정의된 태그 목록에는 이러한 기능이 포함되어 있지 않습니다. 하지만 강조/강조를 달성할 수 있는 방법을 알고 계십니까?코드 위를 이동할 때 툴팁에도 표시되는 경우가 좋습니다.

우리는 가지고 있다.<c>그리고.<code>하지만 그들은 이미 그들의 의미론을 가지고 있습니다.

이 기능은 이제 Visual Studio 2019 버전 16.3.0(릴리스 노트)에서 사용할 수 있습니다.

• 당신은 할 수 .<i>또는<em>이탤릭체의 태그입니다.
• 당신은 할 수 .<b>또는<strong>굵은 글씨의 태그입니다.
• 릴리스 노트에서 다양한 HTML 태그가 지원되는 것처럼 보이지만 공식 설명서는 아직 이 새로운 기능으로 업데이트되지 않은 것 같습니다.

다음과 : 같표시다니됩이과다음..

OP 주의사항:이것은 2019년 Visual Studio 업데이트 전에 승인된 답변이고 그 이후에 다른 답변을 수락했습니다.이 업데이트는 해당 업데이트가 없는 사용자에게 여전히 유용하고 유효합니다.

---

엄밀하게는 안 돼요.그러나 Sandcastle(문서에서 HTML을 생성하는 문서 생성기)은 HTML을 사용할 수 있도록 지원하므로 다음을 사용할 수 있습니다.<em>그리고.<strong>샌드캐슬로 만들면 됩니다.

즉, Jamiec가 이미 언급했듯이 XML 문서 주석은 XML에 불과합니다.따라서 유효한 XML을 여기에 넣을 수 있습니다. 컴파일러는 문서 XML 파일에 해당 XML을 기꺼이 기록합니다.파일을 처리하는 소프트웨어에 따라 다릅니다.Sandcastle은 출력 형식이기 때문에 모르는 모든 것을 HTML로 전달합니다.

Visual Studio는 도움말 도구 설명을 표시할 때 이러한 정보를 무시합니다.

+Q 보기의 ReSharper는 HTML 태그를 텍스트로 표시하여 상황을 약간 추하게 만듭니다.

그러나 다른 사용자가 사용할 라이브러리를 작성한 경우에만 이러한 문제가 발생합니다.그러나 이는 IDE 내에서 아무도 귀하의 강조점을 의도한 대로 볼 수 없다는 것을 의미합니다.

API 문서를 작성할 때 강조할 필요가 거의 없습니다. 종종 문장을 다르게 쓰거나 끝에 가까운 별도의 단락에 중요한 노드를 갖도록 재구성할 수 있으므로 강조할 필요가 전혀 없습니다.일관된 언어와 표현은 독자들이 일단 그것에 익숙해진 후에 중요한 노트를 집어 들도록 도와줍니다.

당신의 코드는 아마도 예시였을 것이지만, 요약은 유형이나 방법이 무엇인지에 대해서만 기록하기 때문에 가장 강조할 필요가 없다고 생각합니다.만약 있다면, 그것을 발언에 사용하고, 그것이 실제로 필요한지 신중하게 고려할 것입니다.

강조를 추가하는 다른 방법은 다음과 같습니다.

 - Upper case:    some BOLD text       // you are shouting, but they WILL read it
 - First letter:  some Bold text       // less emphasis
 - Asterisks:     some **bold** text   // 2 asterisks seem to work best
 - Dashes:        some --bold-- text   // less emphasis

일반 텍스트는 구식이지만 매우 효과적일 수 있으며 기술이 변화한 후에도 작동합니다.

다른 방법은 대신 위키 마크업과 같은 스타일을 사용하는 것입니다.

/// <summary>Cleanup method. This is *recommended* way of cleanup.</summary>
public void CleanAll();

편집 1: AFAIK 비주얼 스튜디오는 위키 마크업을 이해하지 못합니다.저는 단지 위키 마크업을 관례로 사용하자고 제안한 것입니다.팀은 메소드의 인텔리전스에서 원시(비포맷) Wiki 마크업을 계속 볼 수 있습니다.

승인된 답변에 대한 설명을 추가하려면('이 기능은 Visual Studio 2019 버전 16.3.0' https://stackoverflow.com/a/58227889/17203657) 에서 사용할 수 있습니다.

릴리스 정보(https://learn.microsoft.com/en-us/visualstudio/releases/2019/release-notes-v16.3#net-productivity-163P1) 'XML 주석에 대한 Quick Info 스타일 지원이 시작되었습니다.'

Quick Info는 메서드 위에 마우스를 놓으면(Intellisense가 아님) 굵은 글씨체, 이탤릭체를 지원합니다.

IntelliSense는 메서드에 인수를 추가할 때 표시되는 항목으로, 굵은체, 기울임꼴을 지원하지 않습니다.

VS 16.11.5 이후로는 IntelliSense 보기에 굵은 글씨 또는 기울임꼴을 추가할 수 있는 방법을 찾지 못했습니다.

참고: 포인트가 부족하여 주석으로 추가할 수 없습니다.

Intelli sense 디스플레이에 줄 바꿈을 추가하려다가 우연히 <cref="를 발견했습니다.설명서에 따라 클릭 가능한 참조를 설명서에 삽입하는 참조"/>(여기 참조).Intellisense 툴팁을 클릭하는 방법을 알지 못했지만, 참조를 돋보이게 하는 유형 형식의/색상 디스플레이를 제공합니다(Intellisense에서 참조를 사용할 수 있어야 함).

측면 참고:저는 한 줄로 끊는 법을 전혀 몰랐어요.내가 얻을 수 있는 가장 가까운 것은 <para/> 태그를 사용하는 이중 줄 바꿈입니다.

언급URL : https://stackoverflow.com/questions/37674756/bold-or-italic-in-c-sharp-or-vb-documentation-comments