PowerShell cmdlet多行代码文档和换行

时间:2016-04-25 11:59:01

标签: powershell

我有一些PowerShell cmdlet,我在代码documentation中创建了它。除了一件事,一切正常。如果我对任何文档部分有详细描述,我将它分成多行,以便可以从代码中轻松读取。但是我注意到那些新的行字符也在PowerShell系统中表示为新行。

举个例子,这是文档的一部分

Get-Help

现在,当我在包含此类注释的cmdlet上运行 -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

请注意,第一行被正确包裹,但第二行(以单词{{1}}开头)也从新行开始。

我可以通过将整个文档块放在一行来克服这个问题,但从可读性的角度来看,这不会太好。

有没有办法处理整个文档块,因为它是同一文本块的一部分,但同时将注释组织成多行?我在文档中可以告诉我的任何方式,我打算制作一个新段落,我想继续以前的段落吗?

1 个答案:

答案 0 :(得分:1)

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

在编辑器中使用自动换行,并将所有内容保存在一行中。保持WW可以访问热键,以便在需要编辑时快速从一行切换到文本块。一些编辑器(例如vim)非常善于导航包装文本(基本上与未包装文本相同)。