코딩 가이드 라인 : 메소드는 7 개 이상의 명령문을 포함하지 않아야합니까?

나는 C #에 대한 AvSol 코딩 지침 을 살펴 보았고 거의 모든 것에 동의하지만 다른 특정 규칙에 대해 어떻게 생각하는지 궁금합니다.

AV1500

방법이 7 개 진술을 초과해서는 안됩니다. 7 개 이상의 진술이 필요한 방법이 너무 많은 일을하거나 너무 많은 책임이 있습니다. 또한 인간의 마음이 정확한 진술을 분석하여 코드가 수행하는 작업을 이해해야합니다. 스스로 설명하는 이름으로 작고 집중된 여러 가지 방법으로 분류하십시오.

대부분이 규칙을 따르십니까? 가독성을 크게 높이는 것 외에 새로운 메소드를 작성하는 것 (코드가 여전히 DRY ) 에서 절약 할 것이 거의 없습니까? 그리고 당신의 숫자는 여전히 7만큼 낮습니까? 나는 10쪽으로 향하는 경향이 있습니다.

나는이 규칙을 모든 곳에서 위반한다고 말하는 것이 아니라 반대로, 내 방법은 95 % 작고 집중적이지만이 규칙을 위반해서는 안된다는 말은 실제로 나를 날려 버렸다.

나는 모든 사람들이이 규칙을 위반하지 않는다고 생각하는 것을 정말로 알고 싶다. (코딩 표준에서 '1'이다. 그러나 그렇지 않은 코드베이스를 찾는 데 문제가 있다고 생각합니다.

이것은 나에게 "표준 냄새"입니다. 특정 제한이있는 코딩 표준을 볼 때마다 걱정합니다. 거의 항상 메소드가 표준 허용보다 커야하는 경우가 발생합니다 (라인 길이 / 카운트 수, 변수 수, 종료점 수 등). 표준은 지침과 비슷해야하며, 올바른 판단을 내리기에 충분한 여유가 있어야합니다. 틀리지 말고 표준을 갖추는 것이 좋지만 "프록시를 통한 미세 관리"가되어서는 안됩니다.

일반적으로 물건을 작은 방법으로 나누는 것이 좋습니다. 그러나 중요한 것은 의미가있는 부분을 나누는 것입니다.

분할이 타당하지 않으면 분할하지 마십시오. 일부 절차 또는 GUI 코드의 경우가 종종 있습니다.

Steve McConnell 은 Code Complete 에서 짧은 방법을 사용할 때 항상 생산성이 높지는 않다고 말했습니다 . 의미가 없을 때 분할하면 코드에 복잡성을 추가하여 아무런 이점이 없습니다.

항상 지침과 마찬가지로 제약 조건이 존재하는 이유를 기억하는 것이 좋으므로 적용되지 않을 때 배울 수 있습니다. 대부분의 코드에서 메서드가 짧거나 DRY 또는 문제 분리에 문제가있을 수 있습니다. 그러나 그렇지 않다면 괜찮습니다.

경험 법칙으로 간주해야합니다.

"텍스트 열 80 (100,120) 개 이하", "방법 당 하나의 종료점", "2 단계 이하의 중첩"과 같은 것은 코드 냄새 표시기의 임계 값이라고 부르는 것입니다. 때때로 위반하는 경우 코드가 잘못되었다는 의미는 아닙니다. 자신이 지속적으로 위반하는 것을 발견하면 코드에서 무언가 냄새가 나고 잠시 멈추고 접근 방식을 다시 생각할 수 있습니다.

나에게 가장 중요한 기준은 "이 코드를 이해할 수 있는가?", "반복적인가?", "논리적 장소에서 나뉘어 집니까?", "느슨하게 결합되어 있습니까?"입니다. 몇 가지가 더 있지만, 저는 도널드 크 누스의 조언을 기억함으로써 기본적인 아이디어를 요약 할 수 있다고 생각합니다. "프로그램은 인간이 읽고 컴퓨터를 실행할 수 있도록 의도 된 것입니다."

필자는 실제로 메서드의 문 수를 계산하는 데 시간을 들이지 않았지만 하나의 명확한 목적을 명확하게 수행하는 메서드를 작성하려고 노력합니다. 코드가 깨끗하고 읽기 쉽고 DRY 및 단일 책임 원칙을 따르는 한, 아마도 작업을 수행 한 것입니다. 7 문장 제한을 강제하기 위해 메소드를 임의로 분리하면 코드를 읽기 어렵게 만들 수 있다고 생각합니다.

대략적인

이런 종류의 규칙은 문자 그대로 받아 들여서는 안됩니다. 그들은 " 방법이 짧아야한다 " 고 말할 수있었습니다 . 그러나 일부 사람들은 "1 페이지 미만"으로 해석하고 다른 사람들은 "최대 2 줄"로 해석했을 것입니다.

나는 그들이 당신에게 대략적인 아이디어를주기 위해 "7 개의 진술"을했다고 가정 할 것입니다. 한 번에 9가 필요하다면 땀을 흘리지 마십시오. 하지만 20을 쳤다면이 규칙에 맞는 구장에 있지 않다는 것을 알게 될 것입니다.

7은 의미가 전혀없는 완전 임의의 숫자입니다.

순환 복잡도 는 진술의 수보다 더 큰 문제입니다. 단일 방법으로 100 개의 문장을 가진 코드를 보았지만 (끔찍하다고 생각했지만) 순환 복잡성이 1이고 실제로는 한 가지 일만했습니다. 많은 단계가있었습니다. 우리는 더 작은 메소드로 나누는 것에 대해 논의했지만, 이러한 메소드는이 하나의 메소드에 의해서만 호출됩니다.

이는 극단적 인 경우이지만 코드를 DRY로 유지하고 순환 복잡성을 낮추어야합니다. 메소드의 행 수보다 더 중요합니다.

스위치 / 케이스 문을 예로 들어 보자. 7 개 이상의 가능한 값이있는 경우 평가를 여러 방법으로 나누어야합니까? 물론, 그것은 어리석은 일입니다.

7 이하의 문장 수를 유지하기 위해 인위적으로 코드를 더 많은 방법으로 나누면 코드가 악화됩니다.

지침은 다음과 같습니다 각 방법은 한 가지 일을하고 코드를 건조하게 유지해야합니다.

글쎄, 그것은 조금 다릅니다. 데이터베이스에 액세스하는 많은 코드를 작성합니다. 예외 처리를위한 보일러 플레이트 코드는 많은 경우에 7 개 이상의 진술입니다. 최선의 지침은 함수가 하나의 목적을 가지고 있는지 확인하는 것입니다.

모든 것이 절충입니다. 제안 된 접근 방식의 문제점-여러 방법과 클래스로 리팩토링하여 각 방법이 짧아짐-다른 이유로도 극단적 인 경우 읽을 수없는 코드로 이어진다는 것입니다.

foo()7 가지 일을 하는 방법 을 상상해보십시오 . 7 가지가 너무 많다고 주장 할 수 있습니다. 아마도 많은 경우에 당신이 옳을 것입니다. 반면에이 7 가지 사항은 밀접한 관련이있을 수 있습니다. 논리는 매끄럽게 흐르고 산문처럼 읽을 수 있습니다. 실제로 필요할 때 이해하는 데 어려움이 없을 수 있습니다. 더 나쁜 결과는 7 가지를 큰 소스 트리에 분산 시켜서 foo()7 가지 다른 장소를 보지 않고 그 기능이 무엇인지 전혀 모르는 것입니다.

많은 사람들이 머리에 이와 같은 규칙을 얻습니다. 결과는 OO 스파게티로 생각됩니다. 모든 것이 깔끔하고, 작은 방법 또는 클래스로 박스 화되어 있으며, 각 장소에서 원자 적으로 작은 마이크로 트랜잭션이 발생합니다. 그러나 그러한 코드 기반을 새롭게하고 그것이 무엇을하고 있는지 아는 것은 불가능합니다. 당신은 길을 잃게됩니다.

나쁜 지침이 아닙니다. 나는 그룹화되고 충분히 관련되어있는 한 메소드와 클래스를 나누는 것을 결코 후회하지 않았습니다.

요령은 그것을 수직으로 나누지 않는 것입니다 (한 지점에서 방법을 집어 내고 새로운 방법을 시작하십시오). 단위 테스트와 마찬가지로 트릭은 처음부터 이러한 규칙을 염두에두고 실제로 메서드를 더 잘 설계하고 메서드 중 3 개 또는 4 개의 문을 다른 메서드로 전달하는 것입니다. 코드 중간에있는 3 개 또는 4 개의 진술.

이러한 종류의 분할은 임의적이고 한 번만 사용하더라도 나중에 새로운 코드의 명확성으로 인해 더 나은 리팩토링으로 이어질 수 있습니다. 이는 작은 클래스에서도 마찬가지입니다.

단위 테스트처럼 생각하십시오. 사실 후에 단위 테스트를 추가하려고하면 어렵고 때로는 불가능한 것처럼 보이지만 처음부터 디자인하면 실제로 모든 코드가 향상됩니다.

요약? "7 개 미만의 문 사용"의 디자인 냄새를 "7 개 이상의 문을 사용한"코드 냄새와 비교하면 코드 냄새가 제거됩니다.

와! 나는 당신의 방법이 매우 작아야한다고 대략적으로 말하는 간단한 지침에 대해 그렇게 강렬한 토론을 기대하지 않았습니다. 가이드 라인을 명시 적으로 표현하려는 개발자는 항상 개발자이기 때문에 7이 좋은 선택입니다.

일부는 이미 문서의 시작 부분에 고지 사항을 인용했습니다. 그러나이 문서는 더 나은 코드를 작성하고 더 나은 시스템을 설계하는 데 도움이되는 지침 모음을 나타냅니다. 가이드 라인이 레벨 1로 표시되어 있어도 규칙이되어야한다고 언급 한 적이 없습니다. 이러한 레벨은이 문서를 한동안 사용해온 많은 사람들의 단순한 의견입니다.

나는 또한 전문가라고 주장한 적이 없다. 그러나 나는 약 4 년의 C ++ 경험과 11 년의 C # 경험으로 15 년 동안이 직업에 종사해 왔습니다. 원래 Industrial Strength C ++를 기반으로했지만 그 이후로 커뮤니티의 의견을 받아 정제했습니다.

어쨌든, 내가 높이려고 한 것은 당신이 계속 스스로 생각해야한다는 것입니다. 7 가지 진술 지침이 유용하지 않다고 생각한다면, 그것을 더 길게 만드는 것보다. 심지어 그 지침을 때때로 위반하는 경우도 있습니다. 나는 단지 그것을 성실하게 위반하고 그 결과를 받아들입니다.

첫째, 규칙이 아니라 지침입니다. 이를 지침이라고하므로 그렇게 취급하십시오. 이것은 (항상처럼) 자신의 판단이 필요하다는 것을 의미합니다

그 외에도이 제약 조건을 준수하지 않는 좋은 코드의 예를 많이 생각할 수 있습니다. 비록 단지 지침 일지라도, 그것은 좋지 않은 것입니다.

위의 진술에 동의합니다. 이것은 단지 지침 일 뿐이며 완벽한 세상에서 모든 것이 대상이되고 모든 프로그램에서 재사용되며 세상은 아름다운 곳이 될 것입니다. 항상 사실이 아니며 때로는 많은 오버 헤드 나 리소스 낭비로 이어질 수도 있습니다. 당신도 그걸 명심해야합니다.

혼합물에 예외 처리를 추가 할 때 꽤 어리 석습니다.

"try, catch, finally"후에는 메소드 당 4 개의 명령문이 남습니다!

또한 개별 필드에서 모든 개별 유효성 검증을 처리하더라도 20 개의 필드 유효성 검증 메소드를 호출하더라도 20 개의 필드 양식에 대해 "validateForm"메소드를 고려하십시오. 이 지침에 따르면 "validateTopOfScreen", "validateMiddleOfScreen"및 "validateBottomOfScreen"과 같은 무의미한 분할로 끝납니다.

문제는 "지침"과 "규칙"을 혼동시키는 것입니다. 규칙은 준수되어야합니다. 가이드 라인은 수행중인 작업과 실제로 더 나은 방식으로 수행 할 수 있는지 고려하도록하는 조언입니다.

평균적으로, 대부분의 프로그래밍은 아마도 가이드 라인을 따라 개선 될 것입니다. 그러나 가이드 라인을 따르게되면 해결하려는 것보다 더 많은 문제가 발생하는 경우가 항상있을 것입니다. 이것이 규칙으로 제시되는 것이 아니라 지침입니다.

이전의 답변자는 가이드 라인을 작성한 사람들이 결코 독단적으로 적용되도록 의도하지 않았으며 문서에 그 영향에 대한 진술을 포함시키지 않았다.

위의 의견에 동의합니다. 나를 위해 7은 임의적이며 루비가있는 일부 언어에서는 유용 할 수 있지만 C #, Java, C ++와 같은 언어에서는이 "7 줄"규칙을 의심합니다. 현재 응용 프로그램에 22 개의 텍스트 필드가 있으며 서버 측 유효성 검사를 수행합니다. 이 메소드는 validateInput ()이며 checkEmailFormat ()과 같은 복잡한 것을 검증하지 않으면 기본 설정은 하나의 메소드 자체에서 모든 필드의 유효성을 검사합니다. 따라서 기본적으로 validateInput 메소드 코드는 복잡한 유효성 검사를 가끔 호출하는 108 줄입니다.

이제 각 필드의 유효성을 검사하기 위해 25 개의 메소드를 호출했다고 가정하십시오. 새로운 개발자가 들어 오면 25 가지 방법을 건너 뛰기 위해 주요 방법으로 들어가고 나가야합니다. 그는 큰 프로젝트에서 길을 잃어야한다.

내 코드를 명확하게하기 위해 실제로하는 것은 기본적 으로이 4 줄이 전하는 일을 말하는 명확한 주석을 제공하는 것입니다.

validateInput (UserObj 사용자) {

// 이름 확인 ....... ......

// 성을 확인 ...... ......

// 이메일 확인 ..... // 이메일 형식을 확인하기에는 너무 복잡하다 정기적 expresion checkEmailFormat (); .... .....

등등.. }

나쁜 규칙. 예외 처리, 데이터베이스 필드 설정, 유효성 검사를위한 코드를 사용하여 대부분의 메소드를 어떻게 7 개의 명령문으로 작성할 수 있습니까? 인라인 람다 함수를 절대 사용해서는 안됩니까?

코드 라인은 임의의 복잡성입니다. 확장 방법을 사용하면 다음과 같은 코드를 만들 수 있습니다

                Parallel.ForEach(regions, region => {   Console.Write(region.Resorts.Where(x => x.name == "Four Seasons").OrderBy(x => x.RegionId).ThenBy(x => x.ResortId).ThenBy(x => x.name).ToList());   });

모든 주니어 프로그래머는이 원칙을 준수해야합니다. 이로 인해 점점 더 많은 라인 코드를 추가하는 대신 바쁜 바의 구조에 대해 생각하게됩니다.

나는 현재 많은 if 문과 함께 550 줄의 코드 메소드를 찾고 있으며 계속해서 리턴합니다. 쓰레기 야 프로그래머는 자신이하고있는 일에 대해서만 생각해야했습니다.