C # .NET belgelerinde satır sonu ekleme


197

Bu daha kolay olmalı ...

Kodumdaki XML belgelerine "kodlanmış" satır sonu eklemek istiyorum

/// <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>

Gördüğünüz gibi, <ve> köşeli ayraç eklediğini gösteren bazı yanıtlar buldum. İlginçtir ki, iyi 'ol <br /> satır sonu, Intellisense açılır penceresinde satır sonu oluşturmaz.

Bu sinir bozucu buluyorum ...

Baska öneri?


3
Visual studio 2019'dan itibaren satır sonları oluşturmak için <br/> kullanmak mümkündür. Cevaba buradan bakın .
23bl

Yanıtlar:


317

<para />Bir paragraf sonu oluşturmak için bir etiket kullanabilir veya metni <para></para>gruplamak ve boş satırı sonradan eklemek için etiket olarak metni etiketlere yerleştirebilirsiniz, ancak buna eşdeğer <br />veya bunun gibi bir şey yoktur . ( Bu eski MS forum gönderisine göre tasarım gereğidir.) Bu dokümantasyondaki mevcut etiketlerin listesini MS'den alabilirsiniz. Kodunuzu belgeleme

Örnek (orijinal OP örneğine göre):

/// <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
Aha! Şimdi yemek yapıyorduk! Teşekkürler! Bu beni uzun zamandır rahatsız ediyor ... Listelenen para seçeneğini gördüm, ancak bunun bir "paramater" kısayolu olduğu varsayıldı.
Tinkerer_CardTracker

2
Benim için çalışmadı. VS 2010'da VB.NET kullanarak, Powertools'un renklendirilmiş parametre seçeneği ile veya bu seçenek olmadan denendi, <para>etiketler yok sayılır ve her şey Intellisense'de tek bir satıra karıştırılır. Hans'ın sorunu açıkladığı bu soruyu buldu: stackoverflow.com/questions/7070737/… .
Neolisk

1
Kapanış </para> etiketini de eklediğinizden emin olun =)
link64

87
Bununla ilgili kötü olan şey, aslında sadece yeni bir satır yerine bir boş satır eklemesidir.
Devid

6
Peki biri aslında iki yerine bir satır eklemenin bir yolunu buldu mu?

75

Bu benim kullanımım, <br/>çalışıyor gibi :)

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

8
Bu cevap neden reddedildi? O inşaat ve kullanma çok daha iyi bir çözüm gibi görünüyor <para>&#160;</para>, <para>&nbsp;</para>... veya görünmez karakter
Dinei

Bu yeni satırlar için geçerlidir, ancak diğer seçenekler gibi şeyler arasına boş satır eklemez.
Yushatak

16
VS'nin son sürümlerinde <para/>sadece satır sonu değil, boş bir satır eklenmiş gibi görünüyor.
Dinei

2
@IlPADlI, kullanım örneği için +1. VS 2012 Ultimate Güncelleme 5 üzerinde çalıştığı onaylandı
Dennis T - Monica'yı eski durumuna getirin -

9
VS 2017: boş satır eklendi, sadece satır sonu ... microsoft emin bize ne yapmak istediğimizi söylemeyi seviyor ...
Assimilater

41

Visual Studio 2019'dan itibaren <br/>yorumlardaki yeni satırlar için kullanın .

Misal:

/// <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>

resim açıklamasını buraya girin

<br/>Bunun yerine kullandığımızda fazladan bir satır eklenmediğine dikkat edin <para>.


4
Yine de yararlıdır, çünkü bu soru C # belgelerinde satır sonu eklemek için en iyi google sonucudur.
Dan

27

<para>İçinde özel karakter, 255 karakter veya görünmeyen karakter içeren bir etiket ekleyin .

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

Bu şekilde çalışacaktır:

resim açıklamasını buraya girin


8
Bu yardımcı olur, ancak &nbsp;işe yaramaz, bunun yerine kullanın/// <para>&#160;</para>
Robert H

1
Ben şahsen /// <para> </para>yapışkan bir not tutuyorum. O zaman sadece kopyala yapıştır! (Ve işe yarıyor - en azından benim için)
Joel

2
Nedenini bilmiyorum, ama kopyala yapıştır /// <para> </para>hiç çalışmıyor. /// <para>&#160;</para>İşler!
wenqiang

8
<para>Etiketi metin blokları arasında kullanmak yerine, etiketi öğedeki ilk <para>paragraf dışındaki tüm paragrafların çevresinde kullanmalısınız <summary>. İçin <typeparam>, <param>, <value>, <exception>, ve <returns>elementler etrafında bunları kullanmak tüm Birden fazla varsa (opsiyonel sadece bu elemanları varsa) paragraflarında. Diğer tüm blok öğeleri için ( <note>başka bir blok öğesinin içi dahil ), <para>yalnızca bir tane olsa bile, tüm paragrafların etrafındaki etiketleri kullanın .
Sam Harwell

1
Kaynak: Sunum stilinin çoğu da dahil olmak üzere bunu yazdım
Sam Harwell

3

<br></br>ve <br />işe yaramıyor gibi görünüyor ve bazen bu gerçekten <para>de endişelerin ayrılması için boş bir çizgiye sahip olma arzusu kadar cümleleri birbirinden ayırmakla ilgili değil. Burada bahsediyorum, çünkü bu soru bu doğadaki birçok kapalı soruya ebeveyn gibi görünüyor.

Çalıştığım tek şey

<para>&#160;</para>

Örneğin

/// <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>

Sonuçları

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.