좋은 코드와 나쁜 코드 : 좋은 코드를 작성하는 것이 중요한 이유와 그 방법

어떤 언어로 코드를 작성할 때 좋은 코딩 방법이 있으며 실제로 나쁜 방법이 있습니다.

컴파일과 실행 시점에 모두 정확할 수 있습니다. 그러나 잘못된 코드는 개발, 디버깅 및 수정에 일부 문제를 일으킬 수 있습니다. 작업장에서 프로그램이 아무리 잘 실행 되더라도 누군가는 어느 시점에서 코드를 읽고 수정해야합니다.

새로운 기능을 추가하거나, 드문 버그를 수정하거나, 작동 방식을 이해하기 위해 읽기만하면됩니다. 마찬가지로, 같은 일을하려면 다른 사람의 코드를 읽어야합니다. 코드를 읽고 이해할 수 있으면 누구나 훨씬 더 잘 이해할 수 있습니다.

좋은 품질의 코드의 중요성을 알기 위해 나쁜 코드 품질로 이어질 수있는 것을 이해해 봅시다. 잘못 작성된 코드는 소프트웨어의 추가 유지 관리, 개선 또는 조정에 필요한 재정적 손실 또는 시간 낭비로 이어질 수 있습니다.

코드를 한 번 작성하고 여러 번 수행하십시오. 따라서 코드를 문서화하는 것이 실제로 중요 해지고 명명 규칙이 실제로 중요해집니다.

며칠 전에 작성한 코드 나 논리를 기억하지 못하는 방식에 대해 동료들을 만나는 경우가 많습니다. 이제 나쁜 코드 스타일을 작성하는 것과 결합하면 수행 한 작업을 이해하는 데 더 많은 시간이 걸립니다. 예술가가 자신의 예술 작품을 이해하지 못하면 상황이 사라지기 시작합니다.

코드 작성시 명심해야 할 핵심 사항

// 구조에 대한 의견

대부분의 현대 언어에는 선언적으로 문서화 된 주석이 있으며 단일 및 다중 회선 주석과 함께 사용하면 코드를보다 이해하기 쉽고 유지 보수 할 수 있습니다.

좋은 코드 주석은 수행 된 것이 아니라 수행 된 이유를 설명합니다. 코드 자체는 수행 된 작업을 설명합니다. 의견의 필요성은 최소화되어야합니다.

톱니 모양

올바른 코드는 그림과 같이 올바르게 구성되어 있습니다. 코드 블록의 시작 위치와 종료 위치를 이해하려는 사람은 코드베이스의 논리를 따르는 것이 분명하고 간단 해 져야합니다.

들여 쓰기 : 일반 규격 4 칸 들여 쓰기

읽어보기

프로젝트의 코드 기반이 앞에 있으면 성가 시지만 설치 및 첫 실행에는 시간이 걸립니다. readme가 유용한 곳입니다.

코드에 액세스하기 전에 프로젝트에 대한 간략한 소개를하는 것이 좋습니다. 제대로 구성된 Readme가 바로 그 작업을 수행합니다. 올바르게 구성된 Readme는 다음과 같습니다.

명명 규칙

여러 번 우리는 Apimanager라는 이름으로 클래스를 만났지만 이름을 보면 클래스의 목적이 명확하지 않습니다.

최상의 코딩 관행 규범에 따르면, 우리 수업은 단일 책임 원칙 (SRP)을 따라야합니다. SRP와 결합 된 적절한 명명 규칙은 프로젝트를 수행하는 동안 우리의 삶을 훨씬 쉽게 만듭니다.

클래스가 집중적 인 작업 단위를 수행하는 경우 명명 규칙도 범위에 따라 달라야합니다. 이것은 코드 블록을보고 변수가 범위를 벗어난 시점과 위치를 구별하기위한 것입니다.

가장 일시적인 객체를 제외하고 의미있는 명명 규칙을 사용하십시오. 무언가의 이름은 객체를 언제 어떻게 사용하는지에 대한 정보를 제공합니다.

마법의 숫자를 피하십시오

매직 넘버는 무엇입니까? 완전히 문서화되지 않은 상수이며 프로그램이 올바르게 작동하려면 특정 값이어야합니다. 그 번호가 왜 선택되었는지 아무도 모릅니다.

가장 마술 적으로, 숫자가 프로그램에 어떤 영향을 미치는지 아무도 모릅니다.

마법의 숫자는 사악하며 눈에 보이지 않아야합니다.

타임 프레임으로 조정

아래 그림은 그 자체를 말합니다.

마감일까지의 코드 품질

깨끗하고 양질의 코드를 작성하기위한 일반적인 방법

코드 품질을 향상시키기 위해 널리 사용되는 단계

양질의 코드를 작성하는 것은 역동적 인 과정입니다. "좋은 코드"를 작성하는 동안 고려해야 할 사항이 몇 가지 더 있습니다.

  • 좋은 코드는 체계적으로 구성되어 있습니다. 클래스의 데이터와 작업이 함께 맞습니다. 클래스간에 외부 의존성이 없습니다. “스파게티”처럼 보이지 않습니다.
  • 좋은 코드는 잘 테스트되었습니다. 테스트는 코드의 실행 사양 및 사용 예제로 사용됩니다.
  • 좋은 코드는 "영리한"것이 아닙니다. 그것은 간단하고 명백한 방식으로 일을합니다.
  • 좋은 코드는 작고 읽기 쉬운 계산 단위로 개발되었습니다. 이 단위는 코드 전체에서 재사용됩니다.

읽어 주셔서 감사합니다. 유용하다고 생각하시면 공유해주세요. :)