AlignAssignmentStatement

심각도 수준: 경고

설명

이 규칙은 해시테이블과 열거 정의에서 정렬이 맞지 않는 할당 연산자를 감지합니다. 연속 할당 진술문은 할당 연산자가 수직으로 정렬될 때 읽기 쉽고 유지하기 쉽습니다.

이 규칙은 해시테이블과 열거 멤버 정의에서 키-값 쌍을 검사하여 기호가 = 일치하는지 확인합니다. 이 규칙을 사용하여 다중 행 해시테이블과 열거 정의에서 일관된 서식을 강제하세요.

이 규칙은 해시테이블 내의 할당과 열거된 할당은 다른 할당과 같은 줄에 나타나는 것을 무시합니다. 예를 들어, 규칙은 를 무시한다 $h = @{ a = 1; b = 2 }.

Example

비준수

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

enum Enum {
    member = 1
    anotherMember = 2
}

Compliant

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

enum Enum {
    member        = 1
    anotherMember = 2
}

Configuration

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

매개 변수

사용 가능하게 설정

이 매개변수는 스크립트애널라이더가 이 규칙에 따라 코드를 검사하는지 여부를 제어합니다. 불리언 값을 받아들입니다. 이 규칙을 활성화하려면 이 매개변수를 로 $true설정하세요. 기본값은 $false입니다.

체크해시테이블

이 매개변수는 ScriptAnalyzer가 해시테이블과 Desired State Configuration(DSC) 구성에서 할당 정렬을 검사하는지 여부를 제어합니다. 불리언 값을 받아들입니다. 이 검사를 비활성화하려면 이 매개변수를 로 $false설정하세요. 기본값은 $true입니다.

AlignHashtableKvpWithInterveningComment

이 매개변수는 정렬 결정 시 중간에 주석이 포함된 해시테이블 키-값 쌍을 포함하는지 여부를 제어합니다. 불리언 값을 받아들입니다. 이 선들을 제외하려면 이 매개변수를 로 $false설정하세요. 기본값은 $true입니다.

다음을 고려하십시오.

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

이 설정을 비활성화하면 댓글이 포함된 줄이 무시됩니다. 나머지 선들에 대해 같은 부호가 정렬되어 있습니다:

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

이 설정이 활성화되면 모든 선에 대해 등호가 정렬됩니다:

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

체크에넵

이 매개변수는 ScriptAnalyzer가 열거 멤버 정의에서 할당 정렬을 검사하는지 여부를 제어합니다. 불리언 값을 받아들입니다. 이 검사를 비활성화하려면 이 매개변수를 로 $false설정하세요. 기본값은 $true입니다.

정렬열수회원 개입댓글

이 매개변수는 정렬을 결정할 때 중간에 주석을 포함하는 열거 멤버를 ScriptAnalyzer가 포함하는지 여부를 제어합니다. 불리언 값을 받아들입니다. 이 선들을 제외하려면 이 매개변수를 로 $false설정하세요. 기본값은 $true입니다.

IncludeValuelessEnumMembers

이 매개변수는 정렬을 결정할 때 명시적으로 할당된 값 없이 ScriptAnalyzer가 열거 멤버를 포함하는지 제어합니다. 불리언 값을 받아들입니다. 무가치한 원소를 제외하려면 이 매개변수를 로 $false설정하세요. 기본값은 $true입니다.

다음을 고려하십시오.

enum Enum {
    member = 1
    anotherMember = 2
    anotherDifferentMember
}

이 설정을 비활성화하면, 값을 가진 세 번째 줄은 할당 위치를 선택할 때 고려되지 않습니다.

enum Enum {
    member        = 1
    anotherMember = 2
    anotherDifferentMember
}

이 기능이 활성화되면, 무가치 구성원은 마치 값을 가진 것처럼 정렬에 포함됩니다:

enum Enum {
    member                 = 1
    anotherMember          = 2
    anotherDifferentMember
}
  • Last updated on