Как читать синтаксис документации PowerShell

Question

Я мог бы использовать хорошее объяснение синтаксиса документации PowerShell:

> man Update-Help

SYNTAX
    Update-Help [[-Module] <string[]>] [[-SourcePath] <string[]>] [[-UICulture] <cultureinfo[]>] [-Recurse] [-Credential <pscredential>] [-UseDefaultCredentials] 
    [-Force]  [<CommonParameters>]

    Update-Help [[-Module] <string[]>] [[-UICulture] <cultureinfo[]>] [-LiteralPath <string[]>] [-Recurse] [-Credential <pscredential>] [-UseDefaultCredentials] 
    [-Force]  [<CommonParameters>]

Поэтому я попытался обновить человека:

> Update-Help Get-ChildItem

Ошибка:

Update-Help : No Windows PowerShell modules were found that match the following pattern: Get-ChildItem. Verify the pattern and then try the command again.At line:1 
char:1
+ Update-Help Get-ChildItem
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (Get-ChildItem:String) [Update-Help], Exception
    + FullyQualifiedErrorId : ModuleNotFound,Microsoft.PowerShell.Commands.UpdateHelpCommand

В частности, я хочу знать, какие параметры являются обязательными, каков тип этих параметров и должны ли они прийти в определенном порядке?

Answer 1

man Update-Help

Во-первых, имейте в виду, что man (на самом деле Get-Help) не покажет вам полную справку, которая доступна для командлета по умолчанию. Основной вывод просто не дает вам то, что вам нужно, в удобном для чтения виде.

Если вы используете Get-Help Update-Help -online или Get-Help Update-Help -ShowWindow вы получите гораздо больше подробностей. Один бит информации - это список каждого параметра, их положение (если они могут использоваться без параметра -param), если оно является обязательным, значение по умолчанию и т.д.

Вы также можете получить подробную информацию о конкретном параметре напрямую, используя что-то вроде Get-Help update-help -Parameter module .

По - моему, действительно полезной частью Get-Help является раздел примеров. get-help update-help -Examples . Как правило, это даст вам несколько примеров того, как использовать командлет.

Поскольку все документы PowerShell находятся в сети, обычно вы можете просто выполнить поиск в Google/Bing, например, powershell update-help чтобы получить ссылку на онлайн-документацию, которая полна, и, на мой взгляд, ее немного легче читать.

Обновление-Помощь Get-ChildItem

Это не удалось, потому что Get-ChildItem - это командлет, а не модуль. Вы можете просто сделать Update-Help без параметров, и это обновит все. Или вы можете найти модуль, членом которого является Get-ChildItem , и обновить этот модуль.

PS C:\users\public> get-command get-childitem

CommandType Name          Version Source
----------- ----          ------- ------
Cmdlet      Get-ChildItem 3.1.0.0 Microsoft.PowerShell.Management

PS C:\users\public> Update-Help -Module Microsoft.PowerShell.Management
PS C:\users\public>