Update-MarkdownHelpModule

参考

模块:: platyPS

更新 markdown 帮助模块文件夹中的所有文件。

语法

Update-MarkdownHelpModule
      [-Path] <String[]>
      [[-Encoding] <Encoding>]
      [-RefreshModulePage]
      [-ModulePagePath <String>]
      [[-LogPath] <String>]
      [-LogAppend]
      [-AlphabeticParamsOrder]
      [-UseFullTypeName]
      [-UpdateInputOutput]
      [-Force]
      [-Session <PSSession>]
      [-ExcludeDontShow]
      [<CommonParameters>]

说明

Update-MarkdownHelpModule cmdlet 更新现有帮助 markdown 文件，并为模块中的新 cmdlet 创建 markdown 文件。此 cmdlet 结合了 Update-MarkdownHelp 和 New-MarkdownHelp cmdlet 的功能来执行批量更新。

示例

示例 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
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

-ModulePagePath

默认情况下使用 -RefreshModulePage 时，它将 .md 文件置于与所有其他文档相同的位置。使用此参数，可以指定新的名称/位置，从而提供更好的放置选项。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Path

指定要更新的 markdown 文件夹的路径数组。文件夹必须包含一个模块页，此 cmdlet 可从中获取模块名称。

类型:	String[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	True

-RefreshModulePage

更新帮助模块时更新模块页。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-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 尚未使用。