C# 또는 VB 설명서 주석의 굵게 또는 기울임 꼴?

Question

사용 방법 굵게 또는 기울임 꼴 문서 주석이 있습니까? 뭔가 같이 :

는

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

List of predefined tags 이러한 기능을 포함하지 않습니다,하지만 당신은/강조 달성을 강조하는 몇 가지 방법을 알고 있습니까? 가급적이면 코드 위로 마우스를 가져 가면 툴팁에 표시 될 수도 있습니다.

여기에 <c>과 <code>이 있지만 이미 의미가 있습니다.

Answer 1

엄격히 말하면, 아니요. 그러나 Sandcastle (문서에서 HTML을 생성하는 문서 생성기)은 HTML을 사용하기 때문에, Sandcastle로 빌드하면 <em>과 <strong>을 사용하면됩니다.

다른 방식으로 말하자면 : Jamiec이 이미 언급했듯이 XML 문서 주석은 단지 XML입니다. 따라서 유효한 XML을 거기에 넣을 수 있습니다. 컴파일러는 그것을 행복하게 문서 XML 파일에 씁니다. 그것은 모두 해당 파일을 처리하는 소프트웨어에 따라 다릅니다. Sandcastle은 HTML로 모르는 것을 전달합니다. 어쨌든 출력 형식이기 때문에.

도움말 툴팁 표시 할 때 비주얼 스튜디오는 단순히 그들을 무시합니다 :

: HTML 태그가 표시됩니다의 Ctrl 키 + Q보기

ReSharper에서을 텍스트 조금 추악한 일을하게하는로

이는 일반적으로 하지만 다른 사람이 사용할 라이브러리를 작성합니다. 그러나 IDE 내의 중 아무도 의도 한대로 강조 할 수 없음을 의미합니다.

API 문서를 작성할 때 실제로 강조 할 점이 거의 없습니다. 종종 문장을 다르게 작성하거나 끝 부분의 별도 단락에 중요한 노드가있는 구조로 강조 할 필요가 전혀 없습니다. 일관된 언어와 구문을 사용하면 독자는 한번 익숙해지면 중요한 노트를 집어 올릴 수 있습니다.

코드가 예일 뿐이므로 요약은 짧은 문장에서 - 유형이 무엇인지 또는 방법이 유의하기 때문에 모든 것을 중시해야한다고 생각합니다. 어떤 것이라도 비고문에서 사용하십시오. 그리고 나서조차도 당신이 실제로 그것을 필요로하는지 신중히 고려할 것입니다.

Answer 2

다른 방법으로 wiki 마크 업과 같은 스타일을 사용하는 것입니다.

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