PowerShell cmdlet 多行代码文档和换行

Question

我在代码中创建了一些 PowerShell cmdlet documentation .除了一件事，一切正常。如果我对任何文档部分有很长的描述，我会将其分成多行，以便可以轻松地从代码中读取。但是，我注意到那些换行符随后在 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 开头)也另起一行。

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

有没有一种方法可以将整个文档 block 视为同一文本 block 的一部分，但同时将注释组织成多行？我可以在文档中以任何方式表明我不打算制作新段落，而是想继续之前的段落吗？

Answer 1

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

在您的编辑器中使用自动换行，让所有内容都在一行中。保留 WW 可访问的热键，以便您可以在需要编辑时快速从一行文本切换到文本 block 。一些编辑器(例如 vim)非常擅长导航换行文本(与未换行基本相同)。