AlignAssignmentStatement (på engelska)

Allvarlighetsgrad: Varning

Beskrivning

Denna regel upptäcker feljusterade tilldelingsoperatorer i hashtabeller och enum-definitioner. På varandra följande tilldelningssatser är lättare att läsa och underhålla när deras tilldelningsoperatorer är vertikalt justerade.

Denna regel kontrollerar nyckel-värde-par i hashtabeller och enum-medlemsdefinitioner för att säkerställa att tecknen = stämmer överens. Använd denna regel för att upprätthålla konsekvent formatering i flerradiga hashtabeller och enum-definitioner.

Regeln ignorerar tilldelningar inom hashtabeller och enums som visas på samma rad som andra tilldelningar. Till exempel ignorerar $h = @{ a = 1; b = 2 }regeln .

Example

Ej överensstämmande

$hashtable = @{
    property = 'value'
    anotherProperty = 'another value'
}

enum Enum {
    member = 1
    anotherMember = 2
}

Godkänd

$hashtable = @{
    property        = 'value'
    anotherProperty = 'another value'
}

enum Enum {
    member        = 1
    anotherMember = 2
}

Konfiguration

Rules = @{
    PSAlignAssignmentStatement = @{
        Enable                                  = $true
        CheckHashtable                          = $true
        AlignHashtableKvpWithInterveningComment = $true
        CheckEnum                               = $true
        AlignEnumMemberWithInterveningComment   = $true
        IncludeValuelessEnumMembers             = $true
    }
}

Parameters

Enable

Denna parameter styr om ScriptAnalyzer kontrollerar koden mot denna regel. Den accepterar ett boolesk värde. För att aktivera denna regel, sätt denna parameter till $true. Standardvärdet är $false.

CheckHashtable

Denna parameter styr om ScriptAnalyzer kontrollerar tilldelningsjustering i hashtabeller och Desired State Configuration (DSC)-konfigurationer. Den accepterar ett boolesk värde. För att inaktivera denna kontroll, sätt denna parameter till $false. Standardvärdet är $true.

JusteraHashtabellKvpMedMellanliggandeKommentar.

Denna parameter styr om ScriptAnalyzer inkluderar hashtabellens nyckel-värde-par som innehåller en mellanliggande kommentar när justering bestäms. Den accepterar ett boolesk värde. För att utesluta dessa linjer, sätt denna parameter till $false. Standardvärdet är $true.

Tänk på följande:

$hashtable = @{
    property = 'value'
    anotherProperty <#A Comment#> = 'another value'
    anotherDifferentProperty = 'yet another value'
}

Med denna inställning avstängd ignoreras raden med kommentaren. Likhetstecknen är justerade för de återstående linjerna:

$hashtable = @{
    property                 = 'value'
    anotherProperty <#A Comment#> = 'another value'
    anotherDifferentProperty = 'yet another value'
}

Med denna inställning aktiverad är likhetstecknen justerade för alla linjer:

$hashtable = @{
    property                      = 'value'
    anotherProperty <#A Comment#> = 'another value'
    anotherDifferentProperty      = 'yet another value'
}

CheckEnum

Denna parameter styr om ScriptAnalyzer kontrollerar tilldelningsjustering i enum-medlemsdefinitioner. Den accepterar ett boolesk värde. För att inaktivera denna kontroll, sätt denna parameter till $false. Standardvärdet är $true.

JusteraEnumMedlemMedMellanliggandeKommentarT

Denna parameter styr om ScriptAnalyzer inkluderar enummedlemmar som innehåller en mellanliggande kommentar vid bestämning av justering. Den accepterar ett boolesk värde. För att utesluta dessa linjer, sätt denna parameter till $false. Standardvärdet är $true.

InkluderaVärdelösaEnumMedlemmar

Denna parameter styr om ScriptAnalyzer inkluderar enum-medlemmar utan uttryckligen tilldelade värden vid bestämning av justering. Den accepterar ett boolesk värde. För att exkludera värdelösa medlemmar, sätt denna parameter till $false. Standardvärdet är $true.

Tänk på följande:

enum Enum {
    member = 1
    anotherMember = 2
    anotherDifferentMember
}

Med denna inställning avstängd räknas inte den tredje raden, som inte har något värde, när man väljer var tilldelningarna ska justeras.

enum Enum {
    member        = 1
    anotherMember = 2
    anotherDifferentMember
}

Med den aktiverad inkluderas den värdelösa medlemmen i justeringen som om den hade ett värde:

enum Enum {
    member                 = 1
    anotherMember          = 2
    anotherDifferentMember
}