Update-MarkdownHelp

參考

模組:: platyPS

更新 PlatyPS Markdown 說明檔。

語法

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

Description

Update-MarkdownHelp Cmdlet 會更新 PlatyPS Markdown 說明檔案，而不會完全取代檔案的內容。

某些參數屬性會隨著時間而變更。例如，參數集、類型、預設值和必要。此 Cmdlet 會更新 Markdown 協助以反映這些變更。它也會將佔位元文字新增至任何新參數的 Markdown 檔案。

若要將變更傳播至 Markdown 說明檔，請執行下列動作：

將新版本的模組載入 Windows PowerShell 工作階段。
執行 Update-MarkdownHelp Cmdlet 來更新檔案。
檢查 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

依參數區段中的名稱依字母順序排序參數。有 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 尚未使用。

共用方式為