2009-01-21 11 views
76

Hat kesintisinin Intellisense belgelerine yansıtılması için bir özet yorumuna nasıl satır sonu ekleyeceğini bilen var mı?Intellisense için yorumlara satır sonları ekleme

Bazı metin belgeleri

Biraz daha:

bu yöntemi kullanırken

/// <summary> 
/// Some text documentation 
/// - a line break - 
/// Some more documentation 
/// </summary> 
public void SomeMethod() { } 

Yani IntelliSense böyle biçimlendirilmiş yöntem için bir özet sunmaktadır .. netleştirmek kod belgeleri varsaymak için dokümantasyon

(Not - 'para' etiketi boş satır sonu oluşturmuyor - denedim!)

cevap

67

Bunu kullanmayı deneyin.

/// <summary> 
/// <para>Paragraph 1.</para> 
/// <para>Paragraph 2.</para> 
/// </summary> 

Ancak boş bir satırın olabileceğini düşünmüyorum. Boş para etiketi göz ardı edilir.

+0

Sadece bir satır sonu istediğini sanıyordum. Asıl boş bir çizginiz olabileceğini sanmıyorum. –

+0

MS, örneğin yöntemlerdeki istisnalarla bunu nasıl yapıyor? – flesh

+4

İstisnalar XML'de ayrı etiketlerdir. O sadece dokümantasyon – bdukes

-2

Eh, bu Xml'dir. Belki &#10;&#13;

+4

hayır ... – flesh

7

Tek umudun muhtemelen bir şey böyle cludgy edilir:

/// <summary> 
/// <para>line one</para> 
/// <para>_</para> 
/// <para>line two</para> 
/// </summary> 
+0

cludgy evet tarafından "' XYZ '" yerine ancak ive bugüne kadar – flesh

23
/// <summary><br /> 
/// <para>To treat comment line like a DIV tag, surround them with PARA tags.</para><br /> 
/// <para>To add a break with whitespace, add the following line:</para><br /> 
/// <para>&#160;</para><br /> 
/// </summary> 
+0

'
var olduğunca yakın şu' yalnız benim için çalıştı . '' etiketlerinin kullanılması, yorumlarımın geri kalanını taşmanın ötesine iten çok fazla dolgu oluşturdu. – drzaus

+3

'  ' Ben TNX :) arıyordu şeydi – Krowi

+0

'
' VS 2017 yılında – David

44

bu deneyin:

/// <summary> 
/// <para> [Non-Breaking Space] </para> 
/// </summary> 

[Non-Breaking Space]Alt + kullanılarak elde edilir (kullanarak Sayısal tuş takımı).

Boş bir yeni satır olarak görünecektir. Bunun eski olduğunu biliyorum, ama bugün benim için çalıştı.

+12

+1 çalışmaz: Ben ** nihayet ** // Magic yazmak için bir yer var, yapmayın dokunma. –

+0

Sadece söylemek istediğim bir şey: WOW! – Joel

+1

Belki de şimdiye kadar gördüğüm aynı seviyelerde aynı anda gerçekleşebilecek en harika ve korkunç şey. Boş satırlar eklemek için Al Erickson'un " " önerisini kullanacağım, ancak girintilemek için bu daha güzel. – Daryl