2009-01-21 77 views
76

是否有人知道如何在摘要註釋中插入換行符,以便將換行符反映到Intellisense文檔中?爲智能感知添加換行符註釋

爲了澄清,假設代碼文檔..

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

所以使用這種方法時,智能感知提供了一個摘要格式如下方法:

一些文本文檔

一些更文件

(注 - 「para」標記不會創建空行換行符 - 我試過了!)

回答

67

請嘗試使用此操作。

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

但我不認爲你可以有一個實際的空行。 空的段標記被忽略。

+0

我以爲你只是想換行。我不認爲你可以有一個真正的空行。 – 2009-01-21 22:07:28

+0

MS如何在例如方法中使用異常? – flesh 2009-01-21 22:20:07

+4

異常是XML中的單獨標記。這不是在摘要中的空行,它只是呈現文檔 – bdukes 2009-01-27 19:08:39

-2

那麼,這是Xml。也許&#10;&#13;

7

你唯一的希望可能是一些cludgy這樣的:

/// <summary> 
/// <para>line one</para> 
/// <para>_</para> 
/// <para>line two</para> 
/// </summary> 
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> 
44

試試這個:使用Alt鍵 + 獲得

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

[Non-Breaking Space](使用數字鍵盤)。

它將顯示爲一個空的新行。我知道這是舊的,但它今天對我有用。