Question

我是Powershell的新手，并且据我所知，它没有Python中的PEP8 / PEP484之类的东西。我从Microsoft找到了this document，在Posh Code中找到了this第三方指南。我编写了以下函数：

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）

您有3个放置文档的位置：

•在函数主体的开头。

•在函数主体的末尾。

•在function关键字之前。空白不能超过一个函数帮助的最后一行和函数之间的一行关键字。

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

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

或

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

并非所有部分都是必需的，您可以仅包含所需的任何部分。这取决于您的用例和公司准则。我通常至少包括.SYSNOPSIS，.DESCRIPTION，.PARAMETERS和.EXAMPLES。

您如何正确记录Powershell功能？

1 个答案: