PowerShell cmdlet多行代碼文檔和行換行

我有一些PowerShell cmdlet，我在其中創建了代碼documentation。除了一件事外，所有的工作都很好。如果我對任何文檔部分有很長的描述，我將它分成多行，以便可以從代碼中輕鬆讀取。但是我注意到那些新的行字符在PowerShell系統中也被表示爲新行。PowerShell cmdlet多行代碼文檔和行換行

作爲一個例子，這裏的文檔

.PARAMETER MyParam 
    This parameter has a long documentation that does not fit into single line, 
    so I'm breaking it down to several lines.

的一部分，現在，一旦我在包含這種評論，我會得到這樣的cmdlet的運行Get-Help。

-MyParam [<SwitchParameter>] 
     This parameter has a long documentation that does not fit 
     into single line, 
     so I'm breaking it down to several lines. 

     Required?     true 
     Position?     named 
     Default value    False 
     Accept pipeline input?  false 
     Accept wildcard characters? false

注意，第一行被正確地包裹，但隨後的第二行（從字so）也開始在新的一行。

我可以通過將整個文檔塊放在一行中來解決這個問題，但這對於可讀性來說並不太好。

有沒有辦法處理整個文檔塊，因爲它是同一個文本塊的一部分，但同時將註釋組織成多行？我可以通過任何方式在文檔中知道我不打算創建一個新段落，而且我想繼續前一個段落？

來源

2016-04-25 RaYell

最好我的身材是把你的字符串，並預折它。我不知道限制是多少，但60可能是一個安全的選擇。這樣它在代碼和幫助中看起來都是一樣的方式http://stackoverflow.com/questions/28243543/equivalent-of-nix-fold-in-powershell/28244470#28244470 – Matt

我不認爲這是可能的，除了預處理幫助字符串與外部腳本。

在編輯器中使用自動換行功能，並將所有內容保存在一行中。保持WW可訪問的熱鍵，以便在需要編輯時快速從一行切換到文本塊。一些編輯器（如vim）在導航包裝文本方面非常優秀（基本上與未包裝的相同）。

來源

2016-04-25 12:50:15 majkinetor

PowerShell cmdlet多行代碼文檔和行換行

回答

相關問題