Update-MarkdownHelpModule
更新 markdown 帮助模块文件夹中的所有文件。
语法
Default （默认值）
Update-MarkdownHelpModule
[-Path] <String[]>
[[-Encoding] <Encoding>]
[-RefreshModulePage]
[-ModulePagePath <String>]
[[-LogPath] <String>]
[-LogAppend]
[-AlphabeticParamsOrder]
[-UseFullTypeName]
[-UpdateInputOutput]
[-Force]
[-Session <PSSession>]
[-ExcludeDontShow]
[<CommonParameters>]
说明
示例
示例 1：更新 Markdown 帮助模块
PS C:\> Update-MarkdownHelpModule -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
此命令根据加载到当前会话中的 cmdlet 更新指定文件夹中的所有文件。
该命令为 .\docs 文件夹中尚未包含的任何 cmdlet 创建 markdown 帮助主题。
参数
-AlphabeticParamsOrder
在 PARAMETERS 节中按名称按字母顺序排列参数。 有 5 个例外：-Confirm、-WhatIf、-IncludeTotalCount、-Skip和 -First 参数将是最后一个。 这些参数很常见，因此具有明确定义的行为。
参数属性
| 类型: | SwitchParameter
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Encoding
指定外部帮助文件的字符编码。 指定 System.Text.Encoding 对象。 有关详细信息，请参阅 about_Character_Encoding。
参数属性
| 类型: | Encoding
|
| 默认值: | UTF8 without BOM |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 1 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ExcludeDontShow
从帮助内容中排除用 DontShow 标记的参数。
参数属性
| 类型: | SwitchParameter
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Force
删除会话中不再存在的帮助文件（例如，如果删除了函数）。
参数属性
| 类型: | SwitchParameter
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-LogAppend
指示此 cmdlet 会将信息追加到日志中，而不是覆盖它。
参数属性
| 类型: | SwitchParameter
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-LogPath
指定日志信息的文件路径。 该 cmdlet 将 VERBOSE 流写入日志。 如果指定 Verbose 参数，此 cmdlet 还会将此信息写入控制台。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 2 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ModulePagePath
默认情况下使用 -RefreshModulePage 时，它将 .md 文件置于与所有其他文档相同的位置。使用此参数，可以指定新的名称/位置，从而提供更好的放置选项。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Path
指定要更新的 markdown 文件夹的路径数组。 文件夹必须包含一个模块页，此 cmdlet 可从中获取模块名称。
参数属性
| 类型: | String[]
|
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
(All)
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-RefreshModulePage
更新帮助模块时更新模块页。
参数属性
| 类型: | SwitchParameter
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Session
提供对远程命令的支持。 传递用于使用 Import-PSSession创建命令的会话。 这是从远程会话获取准确参数元数据所必需的。
参数属性
| 类型: | PSSession
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
刷新输入和输出部分以反映 cmdlet 的当前状态。 警告：此参数将删除对这些部分的任何手动添加。
| 类型: | SwitchParameter
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-UseFullTypeName
指示目标文档将使用全类型名称，而不是参数的短名称。
参数属性
| 类型: | SwitchParameter
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。
输出
此 cmdlet 返回一个 FileInfo[] 对象，用于更新的文件和新文件。
备注
应首先从包含以前版本的帮助的位置导入要更新帮助的模块。 如果未满足此条件，则参数顺序将在更新的帮助中按字母顺序排列，即使参数 AlphabeticParamsOrder 尚未使用。
