Ich habe einige PowerShell-Cmdlets, für die ich den Code documentation erstellt habe. Alles funktioniert gut bis auf eine Sache. Wenn ich eine lange Beschreibung für einen der Dokumentationsabschnitte habe, teile ich ihn in mehrere Zeilen auf, damit er einfach aus dem Code gelesen werden kann. Allerdings habe ich festgestellt, dass diese neuen Zeilenzeichen dann auch als neue Zeilen im PowerShell-System dargestellt werden.PowerShell-Cmdlet Code-Dokumentation mit mehreren Zeilen und Zeilenumbruch
Als Beispiel ist hier Teil der Dokumentation
.PARAMETER MyParam
This parameter has a long documentation that does not fit into single line,
so I'm breaking it down to several lines.
Nun, wenn ich Get-Help auf einem Cmdlet ausführen, die diese Art von Kommentaren enthält ich so etwas zu bekommen.
-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
bemerken, dass die erste Zeile richtig eingewickelt wird, aber dann wird die zweite Zeile (mit dem Wort beginnen so) startet ebenfalls in einer neuen Zeile.
Ich könnte dieses Problem überwinden, indem ich meinen gesamten Dokumentationsblock in eine Zeile stecke, aber das wäre nicht gut für die Lesbarkeit.
Gibt es eine Möglichkeit, den gesamten Dokumentationsblock zu behandeln, da er Teil desselben Textblocks ist, aber die Kommentare gleichzeitig in mehreren Zeilen angeordnet sind? Irgendwie könnte ich in der Dokumentation sagen, dass ich nicht vorhabe, einen neuen Absatz zu machen, und ich möchte den vorherigen fortsetzen?
Am besten würde ich Ihre Schnur nehmen und vorfalten. Ich weiß nicht, was das Limit ist, aber 60 könnte eine sichere Wette sein. So sieht es auf Ihrem Code und in http://stackoverflow.com/questions/28243543/equivalent-of-nix-fold-in-powershell/28244470#28244470 auf die gleiche Weise aus – Matt