C # .NET 설명서에서 줄 바꿈을 추가하는 방법


197

이것은 더 쉬워야합니다 ...

코드의 XML 문서에 "코드화 된"줄 바꿈을 추가하고 싶습니다

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

보시다시피 <및> 괄호 추가를 보여주는 몇 가지 답변을 찾았습니다. 흥미롭게도, 좋은 'ol <br /> 줄 바꿈은 Intellisense 팝업에서 줄 바꿈을 만들지 않습니다.

이 짜증나는 것을 발견 ...

어떤 제안?


3
Visual Studio 2019부터 줄 바꿈을 만들기 위해 <br/>을 사용할 수 있습니다 . 여기 에서 답변을 참조 하십시오 .
23bl

답변:


317

당신은 사용할 수있는 <para />단락 나누기를 생산하기 위해 태그를하거나 텍스트 래핑 할 수 <para></para>그룹 방법 텍스트로 태그를하고 그 뒤에 빈 줄을 추가,하지만에 해당이없는 <br />그런 또는 아무것도. ( 오래된 MS 포럼 게시물 에 따르면 의도적으로 설계된 것입니다.)이 문서 기사에서 사용 가능한 태그 목록을 MS에서 얻을 수 있습니다. 코드 문서화

예 (원본 OP 샘플 기준) :

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

5
아하! 지금 요리하고 있었다! 감사! 이것은 오랫동안 나를 귀찮게 해왔다 ... 나는 파라 옵션이 나열된 것을 보았지만 그것이 "매개 변수"지름길이라고 가정했다.
Tinkerer_CardTracker

2
나를 위해 일하지 않았다. VS 2010에서 VB.NET을 사용하여 Powertools의 색상 매개 변수 옵션을 사용하거나 사용하지 않고 시도하면 <para>태그가 무시되고 Intellisense에서 모든 것이 단일 라인으로 혼합됩니다. Hans가 문제를 설명하는이 질문을 찾았습니다 : stackoverflow.com/questions/7070737/… .
Neolisk

1
닫는 </ para> 태그도 추가해야합니다 =)
link64

87
이것의 나쁜 점은 실제로 새 줄 대신 전체 빈 줄을 하나 추가한다는 것입니다.
DEVID

6
누구든지 실제로 두 줄 대신 한 줄을 삽입하는 방법을 찾았습니까?

75

이것은 내 사용법입니다. <br/>작동 중입니다 :)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>

8
이 답변은 왜 다운 보트입니까? 그것은 작동하고, 사용하는 것보다 훨씬 더 나은 솔루션이 될 것으로 보인다 <para>&#160;</para>, <para>&nbsp;</para>... 또는 보이지 않는 문자
Dinei

이것은 개행에는 효과가 있지만 다른 옵션과 같이 빈 줄을 삽입하지는 않습니다.
Yushatak

16
최신 버전의 VS <para/>에서는 줄 바꿈이 아니라 빈 줄을 추가하는 것 같습니다.
Dinei

2
사용 예는 @IlPADlI, +1입니다. VS 2012 Ultimate Update 5에 대한 작업을 확인했습니다.
Dennis T-복원 모니카-17

9
VS 2017 : 빈 줄 추가, 단순히 줄 바꿈 ... Microsoft는 우리가 무엇을하고 싶은지 말해주는 것을 좋아합니다 ...
Assimilater

41

Visual Studio 2019부터 <br/>주석의 줄 바꿈에 사용하십시오 .

예:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

여기에 이미지 설명을 입력하십시오

<br/>대신 사용할 때 추가 줄이 추가되지 않습니다 <para>.


4
이 질문은 C # 설명서에 줄 바꿈을 추가하는 방법에 대한 최고의 Google 결과이므로 여전히 유용합니다.
Dan

27

추가 <para>거기에 특수 문자, 255 문자, 또는으로 태그를 보이지 않는 문자 .

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

다음과 같이 작동합니다.

여기에 이미지 설명을 입력하십시오


8
그러나 이것은 도움이 &nbsp;사용하는 대신에, 작동하지 않습니다/// <para>&#160;</para>
로버트 H

1
나는 개인적 /// <para> </para>으로 스티커 메모를 유지 합니다. 그런 다음 복사하여 붙여 넣기 만하면됩니다! (그리고 그것은 적어도 나에게는 효과가있다)
Joel

2
이유를 모르겠지만 복사 붙여 넣기 /// <para> </para>가 전혀 작동하지 않습니다. /// <para>&#160;</para>공장!
wenqiang

8
<para>텍스트 블록 사이 에 태그를 사용하는 대신 요소 의 첫 번째 <para>단락을 제외한 모든 단락 주위 에 태그를 사용해야합니다 <summary>. 를 들어 <typeparam>, <param>, <value>, <exception>, 및 <returns>요소의 주위에 그 (것)들을 사용하는 모든 개 이상있는 경우 (선택 만이 요소에있는 경우) 단락. 다른 모든 블록 요소 (다른 블록 요소 <note>내부 포함 )의 <para>경우 모든 단락 주위에 태그가있는 경우에도 태그를 사용하십시오 .
Sam Harwell

1
출처 : 나는 대부분의 프리젠 테이션 스타일을 포함하여 이것을 작성했다 : openstacknetsdk.org/docs-master/html/…
Sam Harwell

3

<br></br><br />작동하지, 때로는 그것을 만드는 방법에 대한 정말하지 않는 <para>문장이 우려 분리를위한 빈 줄을 가지고있는 욕망만큼 분리한다. 이 질문은이 성격에 대한 많은 비공개 질문에 대한 부모 인 것처럼 보이기 때문에 여기에 언급되어 있습니다.

내가 일한 유일한 것은

<para>&#160;</para>

예를 들어

/// <summary>
///     <para>
///         "This sentence shows up when the type is hovered"
///     </para>
///     <para>&#160;</para>
///     <para>int PrimaryKey</para>
///     <para>&#160;</para>
///     <para>virtual Relation Relation</para>
/// </summary>

결과

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.