"거짓"인 부울 함수 인수에 대한 올바른 주석?

일부 오픈 소스 프로젝트에서 다음 코딩 스타일을 수집했습니다.

void someFunction(bool forget);

void ourFunction() {
  someFunction(false /* forget */);
}    

나는 항상 false여기 에 무슨 의미 가 있는지 의심 합니다. "forget"을 의미합니까, "forget"은 해당 매개 변수 (위의 경우와 같이)를 나타내며 "false"는이를 무시하는 것입니까?

어떤 스타일이 가장 자주 사용되며 모호성을 피하는 가장 좋은 방법은 무엇입니까?

게시 한 샘플 코드 forget에서 플래그 인수 인 것처럼 보입니다 . (이 함수는 순전히 가상이기 때문에 확신 할 수 없습니다.)

플래그 인수는 코드 냄새입니다. 함수는 둘 이상의 작업을 수행하며 올바른 기능은 한 가지 작업 만 수행해야 함을 나타냅니다.

플래그 인수를 피하려면 함수를 함수 이름의 차이점을 설명하는 두 개의 함수로 나눕니다.

플래그 인수

serveIceCream(bool lowFat)

깃발 인수 없음

serveTraditionalIceCream()
serveLowFatIceCream()

편집 : 이상적으로는 플래그 매개 변수를 사용하여 함수를 유지할 필요가 없습니다. 무엇의 라인을 따라 경우가 있습니다 파울러가 얽힌 구현 호출 완전히 기능을 분리하는 것은 중복 된 코드를 생성합니다. 그러나 매개 변수화 된 함수의 순환 복잡성이 높을수록이를 제거하는 주장이 더 강력 해집니다.

평신도의 말로 :

• false 리터럴입니다.
• 당신은 문자 그대로 전달 false
• 당신은 someFunction잊지 말라고
• 당신은 말하고있다 someFunction매개 변수는 잊어false
• 당신은 someFunction기억하고 있습니다

내 의견으로는 기능이 다음과 같으면 더 좋을 것입니다.

void someFunction(bool remember);

당신은 그것을 호출 할 수 있습니다

void ourFunction() {
  someFunction(true);
} 

또는 이전 이름을 유지하지만 래퍼 기능을

void ourFunctionWithRemember() {
  someFunction(false);
} 

편집하다:

@Vorac이 언급했듯이 항상 긍정적 인 단어를 사용하려고 노력하십시오. 이중 부정은 혼란 스럽다.

매개 변수의 이름은 잘 지정 될 수 있습니다. 함수의 이름을 모르면 말하기가 어렵습니다. 나는 의견이 기능의 원래 저자에 의해 쓰여진 가정, 그것은 지나가는 것을 상기시켜이었다 false에 someFunction수단을하지만, 사람이 이후에 함께와 주셔서 먼저 눈에 약간 불분명하다.

예를 들어 Code Complete 에서 제안 된 양의 변수 이름을 사용하면 이 스 니펫을보다 쉽게 ​​읽을 수있는 가장 간단한 변경 사항이 될 수 있습니다.

void someFunction(boolean remember);

다음 ourFunction이된다 :

void ourFunction() {
    someFunction(true /* remember */);
}

그러나 열거 형을 사용하면 일부 지원 코드를 희생하면서 함수 호출을 이해하기가 더 쉽습니다.

public enum RememberFoo {
    REMEMBER,
    FORGET
}

...

void someFunction(RememberFoo remember);

...

void ourFunction() {
    someFunction(RememberFoo.REMEMBER);
}

someFunction어떤 이유로 든 서명을 변경할 수없는 경우 임시 변수를 사용하면 코드를 더 쉽게 읽을 수 있습니다. 인간이 코드를 쉽게 구문 분석 할 수있게하는 것 외에 다른 이유없이 변수를 도입하여 조건부를 단순화하는 것과 같습니다 .

void someFunction(boolean remember);

...

void ourFunction() {
    boolean remember = false;
    someFunction(remember);
}

부울 값이 의미가 있도록 변수 이름을 바꿉니다.

이름이 모호하기 때문에 함수에 인수를 설명하기 위해 주석을 추가하는 것보다 백만 배 더 좋습니다.

보다 설명적인 이름으로 로컬 부울을 작성하고 값을 지정하십시오. 그렇게하면 의미가 더 명확 해집니다.

void ourFunction() {
    bool takeAction = false;  /* false means to forget */
    someFunction( takeAction );
}    

변수의 이름을 바꿀 수 없다면 주석은 좀 더 표현력이 있어야합니다.

void ourFunction() {
    /* false means that the method should forget what was requested */
    someFunction( false );
}    

Qt-Style API를 참조 할 때이 정확한 상황을 언급하는 좋은 기사가 있습니다. Boolean Parameter Trap 이라고 불리우며 읽을만한 가치가 있습니다.

그것의 요지는 :

1. bool이 필요하지 않도록 함수를 오버로드하는 것이 좋습니다
2. Esailija가 제안한 것처럼 열거 형을 사용하는 것이 가장 좋습니다.

이것은 기괴한 의견입니다.

컴파일러의 관점에서 볼 때 someFunction(false /* forget */);실제로 someFunction(false);주석이 제거됩니다. 따라서 모든 행은 someFunction첫 번째 (및 유일한) 인수를로 설정하여 호출합니다 false.

/* forget */매개 변수의 이름 일뿐입니다. 아마도 (더럽고 더러운) 알림 일뿐입니다. 실제로 거기에있을 필요는 없습니다. 덜 모호한 매개 변수 이름을 사용하면 주석이 전혀 필요하지 않습니다.

Clean 코드 의 조언 중 하나는 불필요한 주석의 수를 ¹ 줄이고 (썩는 경향이 있기 때문에) 함수와 메소드의 이름을 올바르게 지정하는 것입니다.

그런 다음 주석을 제거합니다. 결국, Eclipse와 같은 최신 IDE는 마우스를 함수 위에 놓으면 코드가있는 상자를 표시합니다. 코드를 보면 모호성이 없어집니다.

¹ 복잡한 코드를 주석 처리해도됩니다.

명백한 의견을 제시하기 위해 의견을 제시 할 수 있습니다. 어떤 사람이 (아마도 당신이) 변경 때문에 따라서, 설명하는 주석에 의존하지 않고 코드 자체 문서화를 만들기 위해 항상 더 나은 true에 false와 주석을 업데이트하지.

API를 변경할 수 없으면 2 가지 옵션을 사용합니다

• 코드에 관계없이 항상 주석이되도록 주석을 변경하십시오. 한 번만 호출하면 문서를 로컬로 유지하므로 좋은 해결책입니다.

     someFunction (거짓 / * true = 잊어 버림, false = 기억 * /);`

• 특히 두 번 이상 호출 할 경우 #defines를 사용하십시오.

     # 정의를 잊어 버리십시오
     #define REMEMBER false
     someFunction (리멤버);

나는 주석을 항상 참으로 만드는 것에 대한 대답 을 좋아하지만, 좋지만이 코드의 근본적인 문제를 놓친다고 생각합니다. 문자 그대로 호출됩니다.

메소드를 호출 할 때 리터럴을 사용하지 않아야합니다. 지역 변수, 선택적 매개 변수, 명명 된 매개 변수, 열거 형-가장 잘 피하는 방법은 언어와 사용 가능한 언어에 따라 다르지만 피하려고합니다. 리터럴에는 값이 있지만 의미가 없습니다.

C #에서는 명명 된 매개 변수를 사용하여이를 명확하게했습니다.

someFunction(forget: false);

또는 enum:

enum Memory { Remember, Forget };

someFunction(Memory.Forget);

또는 과부하 :

someFunctionForget();

또는 다형성

var foo = new Elephantine();

foo.someFunction();

이름은 항상 부울에 대한 모호성을 해결해야합니다. 항상 'isThis'또는 'shouldDoThat'과 같은 부울 이름을 지정합니다. 예를 들면 다음과 같습니다.

void printTree(Tree tree, bool shouldPrintPretty){ ... }

등등. 그러나 다른 사람의 코드를 참조 할 때 값을 전달할 때 주석을 남기는 것이 가장 좋습니다.