정말로 적당한 크기는 무엇입니까?

사용하는 언어에 따라 다르지만 일반적으로 (나의 개인적인 취향에 따라) :

• 이상적으로 , 25 줄 미만.
• 수용 가능한 미만의 35 개 라인.

더 있다면 나중에 돌아와서 다시 작업해야 할 문제입니다.

그러나 현실적으로 , 당신이 무언가를 전달해야 할 때 필요하고 어떤 식 으로든 뱉어내는 것이 더 합리적이라고 생각하는 모든 크기는 때로는 선적하기 전에 누군가가 검토하기를 더 쉽게 만듭니다. (그러나 여전히 나중에 다시 가져옵니다).

(최근에 우리 팀은 코드베이스에서 프로그램을 실행했습니다. 우리는 197 개의 메소드를 가진 클래스를 찾았고 3 개의 메소드 만있는 클래스를 찾았지만 그 중 하나는 600 줄이었습니다. 귀여운 게임 : 2 악의 더 나쁜 점은 무엇입니까?)

이제 더 많은 대답을 얻으려면 … 일반적으로 한 두 명의 위대한 인물을 인용하는 것이 좋습니다 (TM)으로 간주되므로 다음과 같습니다.

모든 것이 가능한 한 단순해야하지만 단순하지 않아야합니다. – 아인슈타인

더 이상 추가 할 항목이 없을 때가 아니라 더 이상 제거 할 항목이 없을 때 완벽하게됩니다. – 생 텍쥐페리 드 A.

주석 스타일에 대한 부록

이것에 대한 부록으로서, 함수는 그 의도를 설명하는 명확한 이름을 가져야합니다. 주석과 관련하여 일반적으로 함수 내부에는 주석을 달지 않습니다.

• 코멘트 말 “왜?” ,
• 코드 는 “어떻게?” .

각 기능의 맨 위에있는 설명 블록 (설명 필요)으로 충분합니다. 함수가 작고 함수 이름이 충분히 명시 적이라면 달성하고자하는 것과 그 이유를 말하면됩니다. 의도가 불분명 한 경우 25-35 라인 규칙을 위반하는 함수의 경우 일부 언어의 필드 또는 블록 시작에 대해서만 인라인 주석을 사용합니다. 예외적 인 상황이 발생할 때 코드 내에서 블록 주석을 사용합니다 (예를 들어 필요하지 않거나 수행하려는 catch 블록은 이유를 알려주는 주석이 있어야 함).

자세한 내용 은 스타일 및 주석 코드 권장 사항에 대한 답변 을 읽으십시오.

답변