如何正确记录 Powershell 函数？

Question

我是 Powershell 的新手，据我所知，它没有像 Python 中的 PEP8/PEP484 这样的东西。我从 Microsoft找到了这份文档，并从 Posh Code 找到了这份第三方指南。我写了以下函数：

function Invoke-Authenticate {

  [CmdletBinding()]
  param (
      [Parameter(Mandatory)]
      [string] 
      # IP address of the OME server
      $Ip,

      [Parameter(Mandatory)]
      # Credentials for the OME server
      [pscredential] $Credentials
  )

  $SessionUrl  = "https://$($IpAddress)/api/SessionService/Sessions"
  $Type        = "application/json"
  $UserDetails = @{"UserName"=$Credentials.username;"Password"=$Credentials.GetNetworkCredential().password;
                   "SessionType"="API"} | ConvertTo-Json
  $Headers     = @{}

  try {
    $SessResponse = Invoke-WebRequest -Uri $SessionUrl -Method Post -Body $UserDetails -ContentType $Type `
                                      -SkipCertificateCheck
    if ($SessResponse.StatusCode -eq 200 -or $SessResponse.StatusCode -eq 201) {
      # Successfully created a session - extract the auth token from the response
      # header and update our headers for subsequent requests
      $Headers."X-Auth-Token" = $SessResponse.Headers["X-Auth-Token"]
    } else {
      Write-Error "OME did not return a 200 or 201 status code. Received $($SessResponse.StatusCode).
      We are unsure why this happened."
    }
  }
  catch [Microsoft.PowerShell.Commands.HttpResponseException] {
    Write-Error "There was a problem authenticating with OME. Are you sure you have the right username and password?"
    return $null
  }
  catch [System.Net.Http.HttpRequestException] {
    Write-Error "There was a problem connecting to OME. Are you sure you have the right IP and that it is available?"
    return $null
  }

  return $Headers

  <#
    .SYNOPSIS
    Authenticates with OME and creates a session

    .DESCRIPTION
    Authenticates with OME and creates a session

    .PARAMETER Ip
    IP address of the OME server

    .PARAMETER Credentials
    Credentials for the OME server

    .INPUTS
    None. You cannot pipe objects to Invoke-Authenticate.

    .OUTPUTS
    hashtable. The Invoke-Authenticate function returns a hashtable with the headers resulting from authentication 
               against the OME server

  #>
}

然而，据我所知，根据指南是正确的，最后的描述对我来说看起来非常愚蠢。我是否缺少 Powershell 的一套编码风格指南，或者这是正确的吗？您是否应该只删除不适用于功能的字段？例如我没有.INPUTS。我应该完全删除它吗？

Answer 1

它被称为“基于评论的帮助”（about_Comment_Based_Help）

\n

您有 3 个选项来放置文档：

\n

\n

\xe2\x80\xa2 位于函数体的开头。

\n

\xe2\x80\xa2 位于函数体末尾。

\n

\xe2\x80\xa2 在函数关键字之前。函数帮助的最后一行和函数关键字之间不能有多个\n空白行。

\n

\n

因此，您可以轻松地将它们放在函数的顶部（内部或外部）：

\n

function Invoke-Authenticate {\n<#\n.SYNOPSIS\n...\n#>\n

\n

或者

\n

<#\n.SYNOPSIS\n...\n#>\nfunction Invoke-Authenticate {\n

\n

并非所有部分都是必需的，您可以只包含您想要的部分。这取决于您的用例和公司指南。我通常至少包括：

\n

.SYNOPSIS

\n

.DESCRIPTION

\n

.PARAMETERS

\n

.EXAMPLES

\n

另一个有用的事情是，如果您碰巧有公司内部帮助页面（例如维基），您可以添加一个链接：

\n

.LINK\nhttps://wiki.my-company.com/my-module/help\n

\n