Update-MarkdownHelp
更新 PlatyPS markdown 帮助文件。
语法
Update-MarkdownHelp
[-Path] <String[]>
[[-Encoding] <Encoding>]
[[-LogPath] <String>]
[-LogAppend]
[-AlphabeticParamsOrder]
[-UseFullTypeName]
[-UpdateInputOutput]
[-Force]
[-Session <PSSession>]
[-ExcludeDontShow]
[<CommonParameters>] 说明
Update-MarkdownHelp cmdlet 更新 PlatyPS markdown 帮助文件，而无需完全替换文件的内容。
一些参数属性会随时间而变化。 例如，参数集、类型、默认值和必需。 此 cmdlet 更新 markdown 帮助以反映这些更改。 它还将占位符文本添加到任何新参数的 markdown 文件中。
若要将更改传播到 markdown 帮助文件，请执行以下作：
- 将新版本的模块加载到 Windows PowerShell 会话中。
- 运行
Update-MarkdownHelpcmdlet 以更新文件。 - 检查 markdown 文件中的新参数元数据。
示例
示例 1：更新文件夹中的所有文件
PS C:\> Update-MarkdownHelp -Path ".\docs"
Directory: D:\working\PlatyPS\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:54 PM 1496 Get-HelpPreview.md
-a---- 5/22/2016 6:54 PM 3208 Get-MarkdownMetadata.md
-a---- 5/22/2016 6:54 PM 3059 New-ExternalHelp.md
-a---- 5/22/2016 6:54 PM 2702 New-ExternalHelpCab.md
-a---- 5/22/2016 6:54 PM 6234 New-MarkdownHelp.md
-a---- 5/22/2016 6:54 PM 2346 Update-MarkdownHelp.md
-a---- 5/22/2016 6:54 PM 1633 Update-MarkdownHelpModule.md
-a---- 5/22/2016 6:54 PM 1630 Update-MarkdownHelpSchema.md此命令更新指定路径中的所有 markdown 帮助文件以匹配当前 cmdlet。
示例 2：更新一个文件和捕获日志
PS C:\> Update-MarkdownHelp -Path ".\docs\Update-MarkdownHelp.md" -LogPath ".\markdown.log"
Directory: D:\Working\PlatyPS\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 8:20 PM 9993 New-MarkdownHelp.md此命令更新 markdown 帮助文件。 它将日志信息写入 markdown.log 文件。
参数
-AlphabeticParamsOrder
在 PARAMETERS 节中按名称按字母顺序排列参数。 有 5 个例外：-Confirm、-WhatIf、-IncludeTotalCount、-Skip和 -First 参数将是最后一个。 这些参数很常见，因此具有明确定义的行为。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Encoding
指定外部帮助文件的字符编码。 指定 System.Text.Encoding 对象。 有关详细信息，请参阅 about_Character_Encoding。
| 类型: | Encoding |
| Position: | 1 |
| 默认值: | UTF8 without BOM |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ExcludeDontShow
从帮助内容中排除用 DontShow 标记的参数。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Force
删除会话中不再存在的帮助文件（例如，如果删除了函数）
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-LogAppend
指示此 cmdlet 会将信息追加到日志中，而不是覆盖它。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-LogPath
指定日志信息的文件路径。 该 cmdlet 将 VERBOSE 流写入日志。 如果指定 Verbose 参数，此 cmdlet 还会将此信息写入控制台。
| 类型: | String |
| Position: | 2 |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Path
指定要更新的 markdown 文件和文件夹的路径数组。
| 类型: | String[] |
| Position: | 0 |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | True |
-Session
提供对远程命令的支持。 传递用于使用 Import-PSSession创建命令的会话。 这是从远程会话获取准确参数元数据所必需的。
| 类型: | PSSession |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-UpdateInputOutput
刷新“输入和输出”部分以反映 cmdlet 的当前状态。 警告：此参数将删除对这些部分的任何手动添加。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-UseFullTypeName
指示目标文档将使用全类型名称，而不是参数的短名称。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
输入
String[]
可以通过管道将路径数组传递给此 cmdlet。
输出
FileInfo[]
此 cmdlet 返回更新文件的 FileInfo[] 对象。
备注
应首先从包含以前版本的帮助的位置导入要更新帮助的模块。 如果未满足此条件，则参数顺序将在更新的帮助中按字母顺序排列，即使参数 AlphabeticParamsOrder 尚未使用。
