PowerShell命令行工具多行代码文档和换行

Question

我有一些PowerShell cmdlets，其中我已经创建了文档。所有东西都运行良好，除了一件事情。如果我为任何文档部分有一个很长的描述，我会将其拆分成多行，以便可以从代码中轻松阅读。然而，我注意到这些新行字符在PowerShell系统中也表示为新行。

例如，这是文档的一部分。

.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开头）也开始了新的一行。

我可以通过将整个文档块放在一行中来解决这个问题，但从可读性的角度来看，这并不好。

有没有一种方法可以将整个文档块视为同一文本块的一部分，同时将注释组织成多行？有没有一种方法可以在文档中说明我不打算创建新段落，而是想继续上一个段落？

- RaYell

---

最好的方法可能是对您的字符串进行预折叠。我不知道限制是什么，但60可能是一个安全的选择。这样它在您的代码和帮助中看起来都一样。https://dev59.com/8Ifca4cB1Zd3GeqPiWi3#28244470 - Matt

Answer 1

我认为除了使用外部脚本对帮助字符串进行预处理之外，这是不可能的。

在您的编辑器中使用单词换行，并将所有内容保持在一行上。保持一个热键可访问WW，以便在需要编辑时快速从一行切换到文本块。某些编辑器（如vim）非常擅长浏览换行文本（基本上与未换行文本相同）。

- majkinetor