에서 청소 코드 저자의 예를 제공합니다

assertExpectedEqualsActual(expected, actual)

vs

assertEquals(expected, actual)

전자는 주장이 어디로 가고 어디에서 오용 될 가능성이 있는지 기억할 필요가 없기 때문에 더 명확하다고 주장했다. 그러나 나는 어떤 코드에서 이전의 명명 체계의 예를 보지 못했고 후자를 항상 볼 수 있습니다. 저자가 주장하는 것처럼 후자가 더 명확하다면 코더가 왜 전자를 채택하지 않는가?

타이핑하는 것이 더 많고 읽기가 더 많기 때문에

가장 간단한 이유는 사람들이 입력을 적게하고 정보를 인코딩하면 더 많은 입력을 의미하기 때문입니다. 읽을 때마다 논쟁의 순서가 무엇인지 잘 알고 있더라도 모든 것을 읽어야합니다. 논쟁의 순서에 익숙하지 않더라도 ...

많은 개발자들이 IDE를 사용합니다

IDE는 종종 가리 키거나 키보드 단축키를 통해 주어진 방법에 대한 문서를 볼 수있는 메커니즘을 제공합니다. 이로 인해 매개 변수 이름이 항상 있습니다.

인수를 인코딩하면 복제 및 커플 링이 발생합니다.

매개 변수의 이름은 이미 그 이름을 문서화해야합니다. 메소드 이름에 이름을 쓰면 메소드 서명에도 해당 정보가 복제됩니다. 또한 메소드 이름과 매개 변수를 연결합니다. 말 expected과 actual우리의 사용자에게 혼란을 줄 수 있습니다. 에서가는 assertEquals(expected, actual)것은 assertEquals(planned, real)기능을 사용하여 클라이언트 코드를 변경 할 필요가 없습니다. 에서가는 assertExpectedEqualsActual(expected, actual)것은 assertPlannedEqualsReal(planned, real)API에 깨는 변화를 의미한다. 또는 메소드 이름을 변경하지 않아서 혼동되기 쉽습니다.

모호한 인수 대신 유형 사용

실제 문제는 동일한 유형이기 때문에 쉽게 전환 할 수있는 모호한 인수가 있다는 것입니다. 대신 타입 시스템과 컴파일러를 사용하여 올바른 순서를 적용 할 수 있습니다.

class Expected<T> {
    private T value;
    Expected(T value) { this.value = value; }
    static Expected<T> is(T value) { return new Expected<T>(value); }
}

class Actual<T> {
    private T value;
    Actual(T value) { this.value = value; }
    static Actual<T> is(T value) { return new Actual<T>(value); }
}

static assertEquals(Expected<T> expected, Actual<T> actual) { /* ... */ }

// How it is used
assertEquals(Expected.is(10), Actual.is(x));

그런 다음 컴파일러 수준에서 적용 할 수 있으며 뒤로 되돌릴 수 없습니다. 다른 각도에서 접근하는 것은 본질적으로 Hamcrest 라이브러리가 테스트를 위해하는 것입니다.

당신은 프로그래밍에 대한 오랜 논쟁에 대해 묻습니다. 얼마나 자세한 정보가 좋습니까? 일반적인 답변으로, 개발자들은 인수의 이름을 밝히는 추가적인 표현이 가치가 없다는 것을 발견했습니다.

자세한 표현이 항상 더 명확하다는 의미는 아닙니다. 치다

copyFromSourceStreamToDestinationStreamWithoutBlocking(fileStreamFromChoosePreferredOutputDialog, heuristicallyDecidedSourceFileHandle)

대

copy(output, source)

둘 다 같은 버그를 가지고 있지만 실제로 그 버그를 찾기가 더 쉬워 졌습니까? 일반적으로 디버그하는 가장 쉬운 방법은 버그가있는 몇 가지를 제외하고 모든 것이 최대로 간결한 경우이며, 무엇이 잘못되었는지를 알려주기에는 장황합니다.

자세한 정보를 추가 한 오랜 역사가 있습니다. 예를 들어, 일반적으로 인기가없는 " 헝가리어 표기법 "이 lpszName있습니다. 그것은 일반적으로 일반 프로그래머 대중의 길가에 떨어졌습니다. 그러나 멤버 변수 이름에 문자를 추가 (같은 것은 mName또는 m_Name나 name_) 일부 서클 인기를하고 있습니다. 다른 사람들은 그것을 완전히 떨어 뜨 렸습니다. 코딩 스타일 문서에 벡터를 반환하는 모든 함수가 함수 호출에서 벡터의 프레임을 지정해야하는 물리 시뮬레이션 코드베이스에서 작업하고 있습니다 ( getPositionECEF).

Apple이 대중화 한 일부 언어에 관심이있을 수 있습니다. Objective-C에는 함수 시그니처의 일부로 인수 이름이 포함되어 있습니다 (함수 [atm withdrawFundsFrom: account usingPin: userProvidedPin]는 설명서에서 withdrawFundsFrom:usingPin:. 함수 이름입니다). Swift는 비슷한 결정을 내 렸으며 함수 호출 ( greet(person: "Bob", day: "Tuesday")) 에 인수 이름을 넣어야합니다 .

"Clean Code"의 저자는 합법적 인 문제를 지적하지만 그의 제안 된 해결책은 다소 우아하지 않습니다. 일반적으로 불명확 한 분석법 이름을 개선하는 더 좋은 방법이 있습니다.

그는 assertEquals(xUnit 스타일 단위 테스트 라이브러리에서) 어떤 인수가 예상되고 어떤 것이 실제인지 명확하게 밝히지 않습니다. 이것은 또한 나를 물었다! 많은 단위 테스트 라이브러리가이 문제를 지적하고 다음과 같은 대체 구문을 도입했습니다.

actual.Should().Be(expected);

또는 비슷합니다. 어느 것보다 확실히 더 명확 assertEquals하지만 또한 훨씬 낫다 assertExpectedEqualsActual. 그리고 그것은 또한 훨씬 더 작곡 가능합니다.

당신은 Scylla와 Charybdis 사이의 경로를 명확하게하기 위해 노력하고 있습니다.

따라서 평가하려는 인터페이스, 두 개체가 동일한 디버그 어설 션을 수행하는 방법을 살펴 봐야합니다.

1. arity와 name을 고려할 수있는 다른 기능이 있습니까?
   아니요, 이름 자체가 충분히 명확합니다.
2. 중요한 유형이 있습니까?
   아니요, 무시하십시오. 이미 했습니까? 좋은.
3. 논쟁에서 대칭인가?
   거의 오류가 발생하면 메시지가 각 인수 표현을 자체 위치에 넣습니다.

따라서 작은 차이가 중요한지, 기존의 강력한 규칙에 포함되지 않는지 살펴 보겠습니다.

주장이 의도 치 않게 바뀌면 의도 한 청중이 불편합니까?
아니요, 개발자도 스택 추적을 받고 버그를 수정하려면 소스 코드를 면밀히 조사해야합니다.
전체 스택 추적이 없어도 어설 션 위치는 해당 질문을 해결합니다. 그리고 그조차도 빠졌고 어떤 메시지에서 분명하지 않은 경우, 그것은 가능성의 최대 두 배입니다.

인수 순서는 규칙을 따르나요?
그런 것 같습니다. 비록 가장 약한 컨벤션처럼 보이지만.

따라서 그 차이는 매우 중요하지 않으며 인수 순서는 function-name으로 인코딩하려는 모든 노력에 부정적인 유용성이 있다는 강력한 규칙으로 덮여 있습니다.

논리적 인 명확성을 추가하지 않는 경우가 종종 있습니다.

"Add"를 "AddFirstArgumentToSecondArgument"와 비교하십시오.

과부하가 필요한 경우 세 가지 값을 추가합니다. 더 의미가있는 것은 무엇입니까?

세 개의 인수를 가진 또 다른 "추가"?

또는

"AddFirstAndSecondAndThirdArgument"?

방법의 이름은 논리적 의미를 전달해야합니다. 그것이 무엇을하는지 알려줘야합니다. 마이크로 레벨에서 어떤 단계를 수행한다고해서 독자가 더 쉽게 할 수있는 것은 아닙니다. 인수 이름은 필요한 경우 추가 세부 사항을 제공합니다. 여전히 더 자세한 정보가 필요하면 코드가 적합합니다.

다른 답변으로 암시 된 다른 것을 추가하고 싶지만 명시 적으로 언급되지 않았다고 생각합니다.

@puck은 "함수 이름에서 처음 언급 된 인수가 실제로 첫 번째 매개 변수라는 보장은 없습니다."라고 말합니다.

@cbojar는 "모호한 인수 대신 형식 사용"이라고 말합니다.

문제는 프로그래밍 언어가 이름을 이해하지 못한다는 것입니다. 그것들은 단지 불투명 한 원자 기호로 취급됩니다. 따라서 코드 주석과 마찬가지로 함수의 이름과 실제로 작동하는 방식간에 상관 관계가있을 필요는 없습니다.

다음 assertExpectedEqualsActual(foo, bar)과 같은 대안 (이 페이지 및 다른 곳)과 비교하십시오 .

# Putting the arguments in a labelled structure
assertEquals({expected: foo, actual: bar})

# Using a keyword arguments language feature
assertEquals(expected=foo, actual=bar)

# Giving the arguments different types, forcing us to wrap them
assertEquals(Expected(foo), Actual(bar))

# Breaking the symmetry and attaching the code to one of the arguments
bar.Should().Be(foo)

이것들은 모두 장황한 이름보다 더 많은 구조를 가지고 있어 언어에 불투명하지 않은 것을줍니다. 함수의 정의와 사용법 도이 구조에 따라 달라 지므로 구현이 수행하는 작업 (이름 또는 주석과 같은)과 동기화되지 않습니다.

이와 같은 문제가 발생하거나 예견 될 때, 컴퓨터에서 좌절감을 외치기 전에 먼저 기계를 비난하는 것이 '공평한'것인지 묻습니다. 다시 말해, 내가 원하는 것을 구별하기에 충분한 정보가 기계에 제공 되었습니까?

같은 호출 assertEqual(expected, actual)만큼 의미가 있습니다 assertEqual(actual, expected), 그래서 우리가 그들을 혼동하기 쉬운 및 기계 앞서 쟁기 잘못된 일을 위해. 우리가 사용하는 경우 assertExpectedEqualsActual대신, 그것은하지 않습니다 수도 우리가 덜 실수를 할 수 있지만, 어떤 기계에 대한 정보를 (가 영어를 이해 할 수 없으며, 이름의 선택은 의미에 영향을 미치지 않습니다) 제공합니다.

키워드 인수, 레이블이 지정된 필드, 고유 한 유형 등과 같이 "구조화 된"접근 방식을 더 선호하는 것은 추가 정보도 기계로 읽을 수 있으므로 기계가 잘못된 사용법을 발견하고 올바른 작업을 수행하도록 도울 수 있다는 것입니다. assertEqual유일한 문제는 부정확 한 메시지가 될 것이기 때문에 경우도 나쁘지 않다. 더 불길한 예는 String replace(String old, String new, String content)혼동하기 쉬우 며 String replace(String content, String old, String new)매우 다른 의미를 갖습니다. 간단한 해결책은 pair를 취하는 [old, new]것인데, 실수로 인해 오류가 즉시 발생합니다 (유형이없는 경우에도).

유형이 있어도 '기계에 원하는 것을 말하지'않을 수 있습니다. 예를 들어, "문자열 형식 프로그래밍"이라는 반 패턴은 모든 데이터를 문자열로 취급하므로 인수를 혼합하여 (이 경우와 같이) 인수를 쉽게 가져 와서 일부 단계 (예 : 이스케이프 처리)를 수행하지 않고 실수로 불변을 제거 할 수 있습니다 (예 : 파싱 ​​불가능한 JSON 만들기) 등

이것은 코드의 한 부분에서 많은 부울 (또는 숫자 등)을 계산하는 "부울 실명"과 관련이 있지만 다른 부울에서 사용하려고 할 때 실제로 나타내는 내용이 확실하지 않은지 여부 우리는 그들이 설명하는 이름 (예를 들어,이 별개의 열거 예이 비교 등을 혼합있어 LOGGING_DISABLED보다는를 false) 우리가 그들을 혼동 경우 오류 메시지가 발생할 수 있습니다.

인수가 어디로 갔는지 기억할 필요가 없기 때문에

정말입니까? 함수 이름에서 첫 번째로 언급 된 인수가 실제로 첫 번째 매개 변수라는 보장은 없습니다. 따라서 어리석은 이름에 맹목적으로 의존하는 것보다 그것을 더 잘 찾고 (또는 IDE가 그렇게하도록하십시오) 합리적인 이름을 유지하십시오.

코드를 읽으면 매개 변수의 이름을 지정할 때 발생하는 상황을 쉽게 확인할 수 있습니다. copy(source, destination)같은 것보다 이해하기가 훨씬 쉽습니다 copyFromTheFirstLocationToTheSecondLocation(placeA, placeB).

저자가 주장하는 것처럼 후자가 더 명확하다면 코더가 왜 전자를 채택하지 않는가?

서로 다른 스타일에 대한 관점이 다르기 때문에 다른 기사의 반대 저자를 찾을 수 있습니다. 누군가 어딘가에 쓰는 모든 것을 따르려고 미쳤다. ;-)

매개 변수 이름을 함수 이름으로 인코딩하면 함수 작성 및 사용 이보다 직관적이라는 데 동의합니다.

copyFromSourceToDestination( // "...ahh yes, the source directory goes first"

함수와 쉘 명령에서 인수의 순서를 잊어 버리는 것은 쉬운 일이며 많은 프로그래머는 이런 이유로 IDE 기능이나 함수 참조에 의존합니다. 이름에 설명 된 주장을 갖는 것이이 의존성에 대한 훌륭한 해결책이 될 것입니다.

그러나 일단 작성된 후에는 대부분의 경우 명명 된 변수가 사용되므로 인수 설명은 명령문을 읽어야하는 다음 프로그래머에게 중복되지 않습니다.

copy(sourceDir, destinationDir); // "...makes sense"

이것의 간결함은 대부분의 프로그래머를 이길 것이며 개인적으로 읽기가 더 쉽습니다.

편집 : @Blrfl이 지적했듯이, 인코딩 매개 변수는 처음에는 함수의 이름을 기억해야하기 때문에 결국 '직관적'이 아닙니다. 이를 위해서는 함수 참조를 찾거나 IDE에서 도움을 받아야 매개 변수 순서 정보를 제공 할 수 있습니다.