it's my Experience C++ Project.

this Project following Google C++ Coding Convention.

함수 (Funtions)

• 매개변수 순서

매개변수의 순서는 입력에서 출력순으로 정의합니다.

C/C++ 함수의 파라미터들은 함수의 입력을 하거나 함수에서 출력되거나 둘다 일수 있습니다. 입력 파라미터는 대체로 값이거나 const 참조들 입니다. 반면 출력과 입/출력 매개변수는 non-const에 대한 포인터들입니다. 함수 매개변수를 줄세움에 있어서 모든 입력 전용 매개변수는 모든 출력 매개변수 앞에 위치시킵니다. 특히 새로운 매개변수를 함수 끝에 추가하지 마세요. 새로운 입력 전용 파라미터는 출력 매개변수 앞에 위치십니다. 왜냐면 새로 추가된 매개변수이기 때문입니다.

이는 엄격한 룰은 아닙니다. 입력과 출력 둘 다인 매개변수라면 (때때로 클라스/구조체) 관련된 함수들과의 일관성을 위해서 위의 규칙을 벗어날수 있습니다.

• 짧은 함수를 작성하라

작고 명확한 함수를 선호합시다.

우리는 때때로 긴 함수가 적절하다는 것을 알고있음으로, 함수의 길이에 대한 제한은 존재하지 않습니다. 하지만 만약 함수의 길이가 약 40 라인을 초과한다면 프로그램의 구조를 해치지 않으면서 쪼갤수 있는가에 대해서 생각해봅시다.

당신이 작성한 긴 함수가 지금은 완벽하게 동작한다고 할지라도 누군가 몇 주후에 이 함수에 새로운 행동을 추가할지도 모릅니다. 이는 찾기 어려운 버그를 생성하는 결과를 초래할수 있습니다. 함수를 짧고 간결하게 하는 것이 다른 사람들이 당신의 코드를 읽고 수정하기 쉽게 만드는 만드는 길입니다.

당신은 일하다가 길고 복잡한 함수를 볼때가 있을겁니다. 기존 코드를 수정하는 것에 겁내지 마세요. 만약 함수에서 그런 느낌을 받았다면 이는 해당 함수가 어렵다는 것을 뜻합니다. 버그를 찾기 힘들고 여러 다른 상황에서 조각으로 사용하고 싶을때 해당 함수를 더 작은 작고 관리 가능한 조각들로 쪼개는 것을 고려해보자.

• 참조 매개변수

참조로 넘겨지는 모든 파라미터들은 반드시 const가 붙어있어야 합니다.

정의:

C에서 변수를 수정해야 한다면 해당 매개변수는 반드시 포인터를 사용해야했습니다. 하지만 C++에선 그 대신에 참조 매개변수로 선언할수 있습니다.

장점:

매개변수를 참조 변수로 선언함으로 (*pval)++와 같은 흉칙한 코드를 피할수 있습니다. 또한 복사 생성자와 같은 몇몇 어플리케이션에서 필요로 합니다. 포인터와 달리 null 포인터가 유효한 값이 아니라는 것을 분명히합니다.

단점:

참조는 포인터 의미체계를 가지면서 값 구문을 가지기때문에 혼란스러울수 있습니다.

결정사항:

함수 매개변수 목록 내에서 모든 참조는 const여야 합니다.

void Foo(const string &in, string *out);

사실 이는 매우 엄격한 컨벤션입니다. 구글 코드에서 입력 매개변수는 값이거나 const 참조입니다. 반면 출력 매개변수는 포인터입니다. 입력 매개변수는 아마 const 포인터가 될겁니다. 그러나 우리는 비 const 참조변수를 절대로 허용하지 않습니다. 컨벤션에 따라 필요한 경우를 제외하고 말이죠. (예 swap())

하지만 아래와 같은 경우 입력 매개변수에 대해서 const T*를 쓰는것이 const T&를 쓰는것보다 선호될수 있습니다.

1. Null포인터를 넘기고 싶을경우
2. 입력에 대해서 함수가 포인터나 참조를 저장할 경우

기억하세요 대부분의 경우 입력 매개변수는 const T&로 지정됩니다. 대신에 const T를 사용함으로 독자들에게 해당 입력은 다르게 사용됨을 암시합니다. 만약 당신이 구체적인 이유가 있다면 const T& 대신에 const T를 선택했다면 그렇게 하세요. 그렇지 않으면 존재하지 않는 설명을 찾게 만들어서 혼란에 빠드릴수 있습니다.

• 함수 오버로딩

독자가 호출 위치를 보고 정확히 어떤 오버로드된 함수가 호출되었는지 알 필요없이 무슨 일이 일어나고 있는지 좋은 아이디어를 얻을수 있는 경우에만 오버로딩된 함수(생성자를 포함해서)를 사용하세요.

정의:

당신은 아마 const string& 를 받는 함수를 작성할수 있습니다 그리고 이를 오버로딩해서 const char*를 받도록 할수 있습니다.

class MyClass { public: void Analyze(const string &text); void Analyze(const char *text, size_t textlen); };

장점:

오버로딩은 동일하게 명명된 함수가 다른 함수를 위할수 있도록 함으로 코드를 보다 직관적으로 만들수 있습니다. 이는 템플릿화된 코드를 위해서 필요합니다. 그리고 이는 방문자들에게 편리할수 있습니다.

단점 :

만약 함수가 매개변수 타입만으로 오버로딩 된다면 독자는 무슨 일이 일어나고 있는지 알기 위해서 C++의 복잡한 일치 규칙을 이해해야할수도 있습니다. 또한 만약 파생된 클래스가 오직 함수의 일부 변형만 재정의 하는 경우 많은 사람들은 상속의 의미로 혼동합니다.

결론 :

만약 당신이 함수를 오버로딩하길 원한다면, Append()보단 AppendString (), AppendInt ()와 같은 인수에 대한 정보로 이름을 한정하는 것이 좋습니다. 만약 가변 개수 매개변수를 지원하는 함수를 오버로딩하고 싶은 경우 사용자가 이니셜 라이저 목록을 사용하여 인수를 지정할수 있도록 std::vector로 만드는 것을 고려해보자.

• 디폴트 매개변수

디폴트 매개변수는 기본값이 항상 동일한 값을 보장하는 경우 비 가상 함수인 경우에만 허용된다. 함수 오버로딩과 동일한 제한을 따르고 기본 인수로 얻은 가독성이 아래 단점보다 중요하지 않은 경우 선호합니다.

장점 :

종종 디폴트 값을 사용하는 함수가 있지만 때로는 기본값을 오버라이딩 하려고 합니다. 디폴트 매개변수를 사용하면 드문 예외에 대해 많은 함수를 정의 없이 쉬운 방법으로 가능하게 합니다. 함수의 오버로딩과 비교할 때, 디폴트 매개변수는 보다 명확한 구문을 가지며 '기본'인수와 '선택적' 인수 사이의 명확한 구분을 제공합니다.

단점 :

기본 인수는 오버로드 된 함수의 의미를 얻기위한 또 다른 방법이므로 함수 오버로드가 발생하지 않는 모든 이유가 적용됩니다.

가상 함수 호출에서 인수의 기본값은 대상 객체의 정적 유형에 의해 결정되며 주어진 함수의 모든 재정의가 동일한 기본값을 선언한다는 보장은 없습니다.

기본 매개 변수는 각 호출 사이트에서 재평가되어 생성 된 코드를 부 풀릴 수 있습니다. 독자는 또한 각 호출에서 변경되지 않고 기본값에서 값이 고정 될 것으로 예상 할 수 있습니다.

함수 시그니처는 종종 호출 시그니처와 일치하지 않기 때문에 함수 포인터는 기본 인수가있을 때 혼란 스럽습니다. 함수 오버로드를 추가하면 이러한 문제점을 피할 수 있습니다.

결론 :

디폴트 매개변수는 가상 함수에서 제대로 작동하지 않을 경우 사용하지 않습니다. 그리고 지정된 기본값이 추정 시점에 따라 동일한 값으로 계산되지 않을 경우 사용하지 않습니다. (예를 들어 void f (int n = counter ++);를 쓰지 마십시오.)

다른 경우에는 디폴트 매개변수가 위의 단점을 극복 할 수 있도록 함수 선언의 가독성을 향상시킬수 있으므로 허용합니다. 확실하지 않을 경우에는 오버로드를 사용하세요