PowerShell के लिए अनुशंसित कोडिंग शैली क्या है?

Question 1

क्या कोई अनुशंसित कोडिंग शैली है जो पॉवरशेल स्क्रिप्ट कैसे लिख सकती है?

यह नहीं है कि कोड की संरचना कैसे करें (मॉड्यूल के उपयोग के लिए कितने कार्य, ...)। यह ' कोड लिखने के तरीके के बारे में है ताकि यह पठनीय हो ।'

प्रोग्रामिंग भाषाओं में कुछ अनुशंसित कोडिंग स्टाइल (क्या इंडेंट करना है , कैसे इंडेंट करना है - स्पेस / टैब्स, कहां नई लाइन बनाना है , कहां ब्रेसेस लगाना है , ...), लेकिन मैंने पावरशेल के लिए कोई सुझाव नहीं देखा है।

मुझे विशेष रूप से दिलचस्पी है:

पैरामीटर कैसे लिखें

function New-XYZItem
  ( [string] $ItemName
  , [scriptblock] $definition
  ) { ...

(मैं देख रहा हूं कि यह 'V1' सिंटैक्स की तरह है)

या

function New-PSClass  {
  param([string] $ClassName
       ,[scriptblock] $definition
  )...

या (खाली विशेषता जोड़ने के लिए क्यों?)

function New-PSClass  {
  param([Parameter()][string] $ClassName
       ,[Parameter()][scriptblock] $definition
  )...

या (अन्य प्रारूपण मैंने शायद जयकुल के कोड में देखा था)

function New-PSClass {
  param(
        [Parameter()]
        [string]
        $ClassName
        ,
        [Parameter()]
        [scriptblock]
        $definition
  )...

या ...?

जटिल पाइपलाइन कैसे लिखें

Get-SomeData -param1 abc -param2 xyz | % {
    $temp1 = $_
    1..100 | % {
      Process-somehow $temp1 $_
    }
  } | % {
    Process-Again $_
  } |
  Sort-Object -desc

या (नई लाइन पर cmdlet का नाम)

Get-SomeData -param1 abc -param2 xyz |
  % {
    $temp1 = $_
    1..100 |
      % {
        Process-somehow $temp1 $_
      }
  } |
  % {
    Process-Again $_
  } |
  Sort-Object -desc |

और क्या करता है, तो देखते हैं -begin, -processऔर -endमानकों? मैं इसे सबसे अधिक पठनीय कैसे बनाऊं?

Get-SomeData -param1 abc -param2 xyz |
  % -begin {
     init
  } -process {
     Process-somehow2 ...
  } -end {
     Process-somehow3 ...
  } |
  % -begin {
  } ....

या

Get-SomeData -param1 abc -param2 xyz |
  %  `
    -begin {
      init
    } `
    -process {
      Process-somehow2 ...
    } `
    -end {
      Process-somehow3 ...
    } |
  % -begin {
  } ....

यहाँ इंडेंटेशन महत्वपूर्ण है और किस तत्व को नई लाइन पर भी रखा गया है।

मैंने केवल उन सवालों को कवर किया है जो मेरे दिमाग में बहुत बार आते हैं। कुछ अन्य हैं, लेकिन मैं इस ढेर अतिप्रवाह प्रश्न को 'संक्षिप्त' रखना चाहूंगा।

अन्य सुझावों का स्वागत है।

Question 2

PowerShell v2.0 में बहुत गहरा गोता लगाने में कुछ साल बिताने के बाद, यहाँ पर मैंने क्या किया है:

<#
.SYNOPSIS
Cmdlet help is awesome.  Autogenerate via a template so I never forget.

.DESCRIPTION
.PARAMETER
.PARAMETER
.INPUTS
.OUTPUTS
.EXAMPLE
.EXAMPLE
.LINK
#>
function Get-Widget
{
    [CmdletBinding()]
    param (
        # Think about which parameters users might loop over.  If there is a clear
        # favorite (80/20 rule), make it ValueFromPipeline and name it InputObject.
        [parameter(ValueFromPipeline=$True)]
        [alias("Server")]
        [string]$InputObject,

        # All other loop candidates are marked pipeline-able by property name.  Use Aliases to ensure the most 
        # common objects users want to feed in will "just work".
        [parameter(Mandatory=$true, Position=0, ValueFromPipelineByPropertyName=$True)]
        [alias("FullName")]
        [alias("Path")]
        [string[]]$Name,

        # Provide and document defaults for optional parameters whenever possible.
        [parameter(Position=1)]
        [int]$Minimum = 0,

        [parameter(Position=2)]
        [int]$ComputerName = "localhost",

        # Stick to standardized parameter names when possible.  *Especially* with switches.  Use Aliases to support 
        # domain-specific terminology and/or when you want to expose the parameter name of the .Net API you're wrapping.
        [parameter()]
        [Alias("IncludeFlibbles")]
        [switch]$All,
    )

    # The three main function blocks use this format if & only if they are short one-liners    
    begin { $buf = new-list string }

    # Otherwise they use spacing comparable to a C# method
    process    
    {
        # Likewise, control flow statements have a special style for one-liners
        try
        {
            # Side Note: internal variables (which may be inherited from a parent scope)  
            # are lowerCamelCase.  Direct parameters are UpperCamelCase.
            if ($All)
                { $flibbles = $Name | Get-Flibble }   
            elseif ($Minimum -eq 0)          
                { $flibbles = @() }
            else
                { return }                       

            $path = $Name |
                ? { $_.Length -gt $Minimum } |
                % { $InputObject.InvokeGetAPI($_, $flibbles) } |
                ConvertTo-FullPath
        }
        finally { Cleanup }

        # In general, though, control flow statements also stick to the C# style guidelines
        while($true)
        {
            Do-Something
            if ($true)
            {
                try
                {
                    Do-Something
                    Do-Something
                    $buf.Add("abc")
                }
                catch
                {
                    Do-Something
                    Do-Something
                }
            }            
        }    
    }    
}

<# 
Pipelines are a form of control flow, of course, and in my opinion the most important.  Let's go 
into more detail.

I find my code looks more consistent when I use the pipeline to nudge all of PowerShell's supported 
language constructs (within reason) toward an "infix" style, regardless of their legacy origin.  At the 
same time, I get really strict about avoiding complexity within each line.  My style encourages a long,
consistent "flow" of command-to-command-to-command, so we can ensure ample whitespace while remaining
quite compact for a .NET language. 

Note - from here on out I use aliases for the most common pipeline-aware cmdlets in my stable of 
tools.  Quick extract from my "meta-script" module definition:
sal ?? Invoke-Coalescing
sal ?: Invoke-Ternary
sal im Invoke-Method
sal gpv Get-PropertyValue
sal spv Set-PropertyValue
sal tp Test-Path2
sal so Select-Object2        
sal eo Expand-Object        

% and ? are your familiar friends.
Anything else that begins with a ? is a pseudo-infix operator autogenerated from the Posh syntax reference.
#>        
function PipelineExamples
{
    # Only the very simplest pipes get to be one-liners:
    $profileInfo = dir $profile | so @{Path="fullname"; KBs={$_.length/1kb}}
    $notNull = $someString | ?? ""        
    $type = $InputObject -is [Type] | ?: $InputObject $InputObject.GetType()        
    $ComObject | spv Enabled $true
    $foo | im PrivateAPI($param1, $param2)
    if ($path | tp -Unc)
        { Do-Something }

    # Any time the LHS is a collection (i.e. we're going to loop), the pipe character ends the line, even 
    # when the expression looks simple.
    $verySlowConcat = ""            
    $buf |
        % { $verySlowConcat += $_ }
    # Always put a comment on pipelines that have uncaptured output [destined for the caller's pipeline]
    $buf |
        ? { $_ -like "*a*" }


    # Multi-line blocks inside a pipeline:
    $orders |
        ? { 
            $_.SaleDate -gt $thisQuarter -and
            ($_ | Get-Customer | Test-Profitable) -and
            $_.TastesGreat -and
            $_.LessFilling
        } |
        so Widgets |        
        % {                
            if ($ReviewCompetition)
            {
                $otherFirms |
                    Get-Factory |
                    Get-ManufactureHistory -Filter $_ |
                    so HistoryEntry.Items.Widgets                     
            }
            else
            {
                $_
            }
        } |            
        Publish-WidgetReport -Format HTML


    # Mix COM, reflection, native commands, etc. seamlessly
    $flibble = Get-WmiObject SomethingReallyOpaque |
        spv AuthFlags 0xf -PassThru |
        im Put() -PassThru |
        gpv Flibbles |
        select -first 1

    # The coalescing operator is particularly well suited to this sort of thing
    $initializeMe = $OptionalParam |
        ?? $MandatoryParam.PropertyThatMightBeNullOrEmpty |
        ?? { pwd | Get-Something -Mode Expensive } |
        ?? { throw "Unable to determine your blahblah" }           
    $uncFolderPath = $someInput |
        Convert-Path -ea 0 |
        ?? $fallback { tp -Unc -Folder }

    # String manipulation        
    $myName = "First{0}   Last{1}   " |
        ?+ "Suffix{2}" |
        ?replace "{", ": {" |
        ?f {eo richard berg jr | im ToUpper}            

    # Math algorithms written in this style start to approach the elegance of functional languages
    $weightedAvg = $values |
        Linq-Zip $weights {$args[0] * $args[1]} |
        Linq-Sum |
        ?/ ($weights | Linq-Sum)
}

# Don't be afraid to define helper functions.  Thanks to the script:Name syntax, you don't have to cram them into 
# the begin{} block or anything like that.  Name, parameters, etc don't always need to follow the cmdlet guidelines.
# Note that variables from outer scopes are automatically available.  (even if we're in another file!)
function script:Cleanup { $buf.Clear() }

# In these small helpers where the logic is straightforward and the correct behavior well known, I occasionally 
# condense the indentation to something in between the "one liner" and "Microsoft C# guideline" styles
filter script:FixComputerName
{
    if ($ComputerName -and $_) {            
        # Handle UNC paths 
        if ($_[1] -eq "\") {   
            $uncHost = ($_ -split "\\")[2]
            $_.Replace($uncHost, $ComputerName)
        } else {
            $drive = $_[0]
            $pathUnderDrive = $_.Remove(0,3)            
            "\\$ComputerName\$drive`$\$pathUnderDrive"
        }
    } else {
        $_
    }
}

स्टैक ओवरफ्लो का सिंटैक्स हाइलाइटर मुझे पूरी तरह से दे रहा है। इसे ISE में पेस्ट करें।

Question 3

मेरा मानना है कि पॉवरशेल के लिए अभी भी सबसे व्यापक कोडिंग स्टाइल संसाधन द पॉवरशेल बेस्ट प्रैक्टिसेस और स्टाइल गाइड है ।

उनके परिचय से:

अंग्रेजी वर्तनी और व्याकरण के नियमों की तरह, पॉवरशेल प्रोग्रामिंग सर्वोत्तम प्रथाओं और शैली के नियमों के लगभग हमेशा अपवाद हैं, लेकिन हम कोड संरचना, कमांड डिजाइन, प्रोग्रामिंग, स्वरूपण और यहां तक कि शैली के लिए एक आधार रेखा का दस्तावेजीकरण कर रहे हैं जो आपको सामान्य समस्याओं से बचने में मदद करेगी, और मदद करेगी आप अधिक पुन: प्रयोज्य, पठनीय कोड लिखते हैं - क्योंकि पुन: प्रयोज्य कोड को फिर से लिखना नहीं पड़ता है, और पठनीय कोड को बनाए रखा जा सकता है।

उन्होंने ये GitBook लिंक भी उपलब्ध कराए:

Question 4

मैं हाल ही में PowerShell में इंडेंट शैली के बारे में एक उत्कृष्ट बिंदु पर आया था । जैसा कि टिप्पणी में कहा गया है, इन समान सिंटैक्स के बीच के अंतर को देखें:

1..10 | Sort-Object
{
    -$_
}

तथा

1..10 | Sort-Object {
    -$_
}

जबकि मेरा झुकाव "रोमन के रूप में करना" है और मानक सी # इंडेंटेशन स्टाइल ( ऑलमैन , अधिक या कम) का उपयोग करना है, मैं इस अपवाद और इसके समान अन्य के साथ मुद्दा लेता हूं।

यह मुझे व्यक्तिगत रूप से मेरे इष्ट 1 टीबीएस का उपयोग करने के लिए उकसाता है , लेकिन मैं अन्यथा आश्वस्त हो सकता हूं। आप कैसे, जिज्ञासा से बाहर निकले?