깔끔한 코드를 기반으로 한 변수 명명

클린 코드는 코드를 더 읽기 쉽고, 유지 관리하기 쉽고, 신뢰할 수 있고 예측 가능하게 하여 효율성을 높이고 팀워크를 촉진할 수 있도록 코드를 작성하는 새로운 방법을 만드는 여러 가지 코드 규칙 집합입니다. .

클린 코드의 여러 원칙 중 하나는 모호성을 피하고 더 깔끔한 코드를 작성하기 위해 자체 설명적이고 자체 설명이 가능한 이름으로 변수 이름을 지정하는 것이라고 위대한 작가인 Zeno Rocha는 자신의 저서 14 Habits of Highly Productive에서 말했습니다. 개발자  우리는 몇 년이 지나도 미래의 내가 이해할 수 있는 코드를 항상 작성해야 합니다. 소형 또는 약어로 변수 이름을 지정하면 해석이 달라질 수 있으며, 특히 프로젝트에 서로 다른 수준으로 참여하는 개발자 간에 이로 인해 향후 문제가 발생할 수 있습니다.

코드 베이스가 커지고 해당 변수가 남겨지면 나중에 다시 검토해야 하는 경우가 많으며, 잘못 작성하면 도움이 되는 코드를 이해하기 어려워집니다.

나쁜 변수의 예:

const date = new Date()
// Nome da varável é muito genêrica e não explica o que ela é

function getData(req, res) {}
// Nâo descreve bem o dado que ela está requisitando 

좋은 변수의 예:

const currentDate = new Date()
// Nome mais explicativo sobre o que ela é e menos genêrico

function getUserGithubCategory(req, res) {} 
// Descreve melhor o dado que a função está requisitando 

의미 있는 변수 이름을 작성하는 동일한 논리에서 또 다른 중요한 점에 도달합니다. 이는 동일한 작성 방향을 따르는 부울 변수를 작성할 때이지만 이전 규칙에 누적되는 또 다른 작은 규칙을 사용해야 한다는 것입니다.

그녀는 다음과 같이 말합니다. 예 또는 아니요로 답할 수 있는 일종의 질문인 것처럼 부울 변수를 작성해야 합니다. 이는 부울 변수가 true(yes) 또는 false(no )와 질문만 받을 수 있기 때문입니다. 활성 여부를 알려주는 것이 코드 판독에 도움이 됩니다.

규칙을 적용하지 않은 예:

const ticketPark = user.ticketPark 

if (!ticketPark ) {
  throw new Error('O Marcos não possui um bilhete para entrar no parque!')
}

규칙을 적용한 예:

const hasUserTicket = user.hasTicket // o usuário tem o ticket ?

if (!hasUserTicket) { // se o usuário não tiver o ticket 
  throw new Error('O Marcos não possui um bilhete para entrar no parque!')
}

이 부울 변수 이름 지정 모델을 사용할 때 공원 티켓이 없는지 확인하는 대신 사용자가 티켓을 가지고 있으면 놀이기구를 타러 갈 수 있다고 말함으로써 읽기가 더 간단해지지 않는다는 점에 동의하십니까? 가짜? 이러한 유형을 사용하면 타사의 코드 이해도가 향상되고 모호함도 방지할 수 있습니다.

마지막으로, 마지막 두 가지 규칙과 함께 코드를 더 잘 작성하는 것 외에도 변수를 사용하여 코드에 '마법의 숫자'를 저장하는 간단한 규칙이 하나 더 있습니다. 하지만 결국, 당신의 코드에 있는 이 마법의 숫자는 무엇입니까? 일반적으로 많은 프로그래머는 비즈니스 규칙을 프로젝트에 적용할 때 다양한 숫자를 사용하여 코드에서 일부 작업을 수행하고 그 이유에 대한 설명 없이 코드에 입력됩니다.

매직 넘버로 가득 찬 코드의 예:

const date = new Date()
// Nome da varável é muito genêrica e não explica o que ela é

코드의 용도를 알 수 있나요?

말할 수 없는 숫자가 힘들죠?

"코드가 깨지는 것을 제거하면 왜 다른지 모르겠습니다"라는 말을 들어본 적이 있습니까? 이것은 내가 여기서 말하고 싶은 것을 잘 나타냅니다. 이 숫자를 느슨하게 두지 말고 왜 존재하는지에 대한 설명 없이 변수에서 명확하게 할 수 없는 경우 코드에 간단한 주석을 작성하십시오.

이 코드를 어떻게 작성해야 하는지 살펴보세요.

function getData(req, res) {}
// Nâo descreve bem o dado que ela está requisitando 

지금은 좀 나아졌죠?

이익

변수 이름을 명확하게 지정하고, 매직 넘버를 피하고, 클린 코드 원칙을 따르는 등의 관행을 채택하면 코드 품질이 향상될 뿐만 아니라 다른 개발자와 공동 작업하고 장기적으로 유지 관리하기가 더 쉬워집니다.

기억하세요: 깔끔한 코드를 작성하는 것은 완벽함을 달성하는 것이 아니라 미래의 귀하를 포함하여 코드를 사용하는 모든 사람이 코드에 더 쉽게 접근하고, 이해하고, 예측할 수 있도록 만드는 것입니다.

다음 프로젝트에 이 규칙을 적용해 보고 차이점을 알아보세요! 보다 생산적이고 효율적인 작업 환경을 조성하려면 이러한 팁을 동료나 팀과 공유하세요. 결국, 잘 작성된 코드는 고품질 소프트웨어를 구축하는 첫 번째 단계입니다.

그럼 오늘부터 시작해 볼까요? 나중에 자랑스럽게 읽을 수 있는 코드를 작성해 보세요!

위 내용은 깔끔한 코드를 기반으로 한 변수 명명의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!