AlignAssignmentStatement

Súlyossági szint: Figyelmeztetés

Leírás

Ez a szabály azonosítja a rosszul igazított operátorokat hashtable-okban és enum definíciókban. Az egymást követő hozzárendelési utasítások könnyebben olvashatók és kezelhetők, ha a hozzárendelési operátorok függőlegesen illeszkednek.

Ez a szabály ellenőrzi a kulcsérték-párokat a hashtable-okban és az enum-tag definícióiban, hogy megbizonyosodjon arról, hogy a = jelek összeegyeznek. Ezt a szabályt használd arra, hogy következetes formázást kényszerítsünk többsoros hashtable-okban és enum-definíciókban.

A szabály figyelmen kívül hagyja azokat a hashtable-okon és enumokban található kiosztásokat, amelyek ugyanazon a soron jelennek meg más hozzárendelésekkel. Például a szabály figyelmen kívül $h = @{ a = 1; b = 2 }hagyja a -t .

Example

Nem megfelelő

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

enum Enum {
    member = 1
    anotherMember = 2
}

Megfelelő

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

enum Enum {
    member        = 1
    anotherMember = 2
}

Konfiguráció

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

Paraméterek

Enable

Ez a paraméter szabályozza, hogy a ScriptAnalyzer ellenőrzi-e a kódot ezen szabály ellen. Elfogad egy boole-értéket. Ennek a szabálynak a engedélyezéséhez állítsuk be ezt a paramétert .$true Az alapértelmezett érték a $false.

CheckHashtable

Ez a paraméter szabályozza, hogy a ScriptAnalyzer ellenőrzi-e a kiosztás igazítását hashtable-okban és a Desired State Configuration (DSC) konfigurációkban. Elfogad egy boole-értéket. Ennek a ellenőrzésnek a kikapcsolásához állítsuk be ezt a paramétert .$false Az alapértelmezett érték a $true.

AlignHashtableKvpWithInterveningComment

Ez a paraméter szabályozza, hogy a ScriptAnalyzer tartalmaz-e hashtable kulcsérték-párokat, amelyek köztes hozzászólást tartalmaznak az igazítás meghatározásakor. Elfogad egy boole-értéket. Ezeknek a soroknak a kizárásához állítsuk be ezt a paramétert .$false Az alapértelmezett érték a $true.

Vegye figyelembe a következőket:

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

Ha ez a beállítás ki van kapcsolva, a hozzászólással kapcsolatos sort figyelmen kívül hagyják. Az egyenlő jelek a fennmaradó vonalakhoz igazítva:

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

Ha ezt a beállítást bekapcsoljuk, az egyenlítési jelek minden vonalra igazítva vannak:

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

CheckEnum

Ez a paraméter szabályozza, hogy a ScriptAnalyzer ellenőrzi-e a kiosztás igazítását az enum tag definícióiban. Elfogad egy boole-értéket. Ennek a ellenőrzésnek a kikapcsolásához állítsuk be ezt a paramétert .$false Az alapértelmezett érték a $true.

AlignEnumMemberWithinterveningComment

Ez a paraméter szabályozza, hogy a ScriptAnalyzer tartalmaz-e enum tagokat, amelyek köztes megjegyzést tartalmaznak az igazítás meghatározásakor. Elfogad egy boole-értéket. Ezeknek a soroknak a kizárásához állítsuk be ezt a paramétert .$false Az alapértelmezett érték a $true.

Include ValuelessEnumTagok

Ez a paraméter szabályozza, hogy a ScriptAnalyzer tartalmaz-e enum tagokat kifejezetten nem rendelt értékek az igazítás meghatározásakor. Elfogad egy boole-értéket. Az értéktelen tagok kizárásához állítsuk be ezt a paramétert .$false Az alapértelmezett érték a $true.

Vegye figyelembe a következőket:

enum Enum {
    member = 1
    anotherMember = 2
    anotherDifferentMember
}

Ha ez a beállítás ki van kapcsolva, a harmadik sor, amelynek nincs értéke, nem veszik figyelembe a kiosztások helyét választva.

enum Enum {
    member        = 1
    anotherMember = 2
    anotherDifferentMember
}

Ha bekapcsoljuk, az értéktelen tag bekerül az igazításba, mintha lenne egy értéke:

enum Enum {
    member                 = 1
    anotherMember          = 2
    anotherDifferentMember
}