Update-MarkdownHelpModule

參考

模組:: platyPS

更新 Markdown 說明模組資料夾中的所有檔案。

Syntax

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

Description

Cmdlet Update-MarkdownHelpModule 會更新現有的說明 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 參數將是最後一個。這些參數很常見，因此具有定義完善的行為。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encoding

指定外部說明檔的字元編碼。指定 System.Text.Encoding 物件。如需詳細資訊，請參閱 about_Character_Encoding。

Type:	Encoding
Position:	1
Default value:	UTF8 without BOM
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcludeDontShow

從說明內容中排除參數屬性中標示 DontShow 的參數。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

移除已不存在於會話中的說明檔 (，例如，如果函式已刪除) 。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogAppend

指出這個 Cmdlet 會將資訊附加至記錄，改為覆寫它。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogPath

指定記錄資訊的檔案路徑。 Cmdlet 會將 VERBOSE 資料流程寫入記錄檔。如果您指定 Verbose 參數，此 Cmdlet 也會將該資訊寫入主控台。

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModulePagePath

使用 -RefreshModulePage 時，預設會將 .md 檔案放在與所有其他檔相同的位置。使用此參數，您可以指定新的名稱/位置，以提供更好的放置選項。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

指定要更新之 Markdown 資料夾的路徑陣列。資料夾必須包含模組頁面，此 Cmdlet 可從中取得模組名稱。

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-RefreshModulePage

更新說明模組時更新模組頁面。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Session

提供遠端命令的支援。使用傳遞您用來建立命令的 Import-PSSession 會話。這是從遠端會話取得精確參數中繼資料的必要專案。

Type:	PSSession
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UpdateInputOutput

重新整理輸入和輸出區段，以反映 Cmdlet 的目前狀態。警告：此參數會移除這些區段的任何手動新增專案。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseFullTypeName

指出目的檔案將使用完整類型名稱，而不是參數的簡短名稱。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

String[]

您可以使用管線將路徑陣列傳送至此 Cmdlet。

輸出

FileInfo[]

此 Cmdlet 會針對更新和新檔案傳回 FileInfo[] 物件。

備註

您要更新說明的模組應該先從包含舊版說明的位置匯入。如果不符合此條件，即使尚未使用 AlphabeticParamsOrder 參數，參數順序也會依更新的說明字母順序。

共用方式為