您如何正确记录 Powershell 函数?

我是 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 。我应该完全删除它吗?

stack overflow How do you correctly document Powershell functions?
原文答案
author avatar

接受的答案

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

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

• 在函数体的开头。

• 在函数体的末尾。

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

因此,您可以轻松地将它们放在函数的顶部(内部或外部):

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

或者

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

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

.SYNOPSIS

.DESCRIPTION

.PARAMETERS

.EXAMPLES

另一个有用的东西,如果你碰巧有一个公司内部帮助页面(比如一个 wiki),你可以添加一个链接:

.LINK
https://wiki.my-company.com/my-module/help

答案: