PowerShell cmdlet 多行代码文档和换行答案

【问题标题】：PowerShell cmdlet multi-line code documentation and line wrappingPowerShell cmdlet 多行代码文档和换行
【发布时间】：2018-03-04 04:17:36
【问题描述】：

我有一些 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.

现在，一旦我在包含此类 cmets 的 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 开头）也开始换行。

我可以通过将我的整个文档块放在一行中来克服这个问题，但这对于可读性的观点来说不太好。

有没有办法将整个文档块视为同一文本块的一部分但同时将 cmets 组织成多行？我可以在文档中以任何方式说明我不打算制作新段落并且我想继续上一个段落吗？

【问题讨论】：

我认为最好的办法是拿起你的绳子并预先折叠它。我不知道限制是多少，但 60 可能是一个安全的赌注。这样它在您的代码和帮助stackoverflow.com/questions/28243543/… 上看起来都是一样的

标签： powershell

【解决方案1】：

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

在您的编辑器中使用自动换行并将所有内容集中在一行上。为 WW 保留可访问的热键，以便在需要编辑时快速从一行文本切换到文本块。有些编辑器（比如vim）在导航换行的文本方面非常出色（基本上和不换行一样）。

【讨论】：