프로젝트에서 나쁜 코드 냄새 찾기(네이밍) 프로젝트 산업 코드 목록 프로젝트 분야 및 코드 Javaee 프로젝트 소스 코드

소개

이 기간 동안 프로젝트를 진행하다 보니 상대적으로 바쁜 시간을 보내고 있습니다. 오늘 드디어 제가 작성한 코드를 잘 살펴보고 문제가 있는 부분이 있는지 살펴보겠습니다. 그리고 "악취"가 있는 곳.

천천히 코드를 외워보세요. 나쁜 냄새를 잡기 시작하십시오.

자주 해보고 생각하는 일

모호한 if 조건

1) ||

처리 > 좋은 목표지만, 코드를 이해하는 데 걸리는 시간을 최소화하는 것이 더 나은 목표입니다.

반환 값

위의 "$ret"은 "생각할 수 없음"을 의미합니다. 이름"이라는 속임수. 이렇게 빈 이름을 사용하는 대신 엔터티의 가치나 목적을 설명하는 이름을 선택하세요.

$alias는 이 변수가 이 변수의 목적을 나타내는 별칭을 전달하는 데 사용된다고 선언합니다. 결함을 찾는 데 도움이 될 수도 있습니다

좋은 이름은 변수의 목적이나 변수가 전달하는 값을 설명해야 합니다.

임시 변수

여기서 $i는 "나의 임시 변수"이며 특별히 Let에 사용됩니다. 통계 포인트의 중복을 피하기 위해 통계 데이터가 자동으로 증가합니다. 하지만 $i에서 가장 중요한 것은 임시 변수가 아닙니다. 보다 "설명적"인 "내 통계 데이터의 첨자"를 나타내려면 charset_index를 사용하십시오.

Loop iterator

js 코드에서도 악취가 발견되었습니다.

i 변수 이름은 매우 일반적이므로 이렇게 하지 마세요.

i, j, iter와 같은 이름이며 일반적으로 인덱스 및 루프 반복자로 사용됩니다. 이름은 모호하지만 "나는 반복자다"라는 뜻이라는 것은 다들 아실 겁니다. - 실제로 이 이름을 다른 의미로 사용하면 매우 혼란스러울 것입니다. 그러니 하지 마세요.

i, j, it처럼 모호한 이름을 고집한다면 설득할 만한 충분한 이유가 있을 것입니다.

요약

코딩하는 과정에서 몇 초만 더 투자해서 좋은 이름을 생각해 보면 우리의 '네이밍 능력'이 금세 개선하다. .

저는 보통 한자 이름을 먼저 생각하는데, 정말 해당 영어 이름이 생각나지 않으면 번역 도구를 사용해 떠오르는 한자 이름을 붙여넣은 후 이름을 잘라냅니다. 변수 또는 함수 이름.

최근 본 멋진 이름을 선물해주세요

원본링크: http://www.cnblogs.com/baochuan/archive/2012/07/12/2588317.html

위 내용은 프로젝트와 코드 측면을 포함하여 프로젝트에서 코드를 찾는 악취(네이밍)를 소개하고 있으니 PHP 튜토리얼에 관심이 있는 친구들에게 도움이 되길 바랍니다.