약간의 변경이 필요합니다. 우리는 그 이유를 명확히 할 필요가 있습니다.

TL;DR: Be declarative on your design or implementation decisions.

문제

코드 주석

테스트 가능성 부족

솔루션

이유를 명시하십시오.

주석을 메소드로 변환합니다.

문맥

때때로 우리는 쉽게 테스트할 수 없는 임의의 규칙을 찾습니다.

실패한 테스트를 작성할 수 없다면 주석 대신 훌륭하고 선언적인 이름을 가진 함수가 필요합니다.

샘플 코드

잘못된

// We need to run this process with more memory
set_memory("512k)

run_process();           

오른쪽

increase_memory_to_avoid_false_positives();
run_process();      

발각

[X] 반자동

이것은 시맨틱 냄새입니다.

댓글을 감지하고 경고할 수 있습니다.

태그

댓글

결론

코드는 산문입니다. 그리고 디자인 결정은 서술적이어야 합니다.

처지

코드 냄새 05 - 댓글 남용자

Maxi Contieri ・ 2020년 10월 24일 ・ 2분 읽기

#codenewbie #tutorial #beginners

Code Smell 75 - 메서드 내 주석

Maxi Contieri ・ 2021년 6월 5일 ・ 2분 읽기

#codenewbie #tutorial #oop #programming

부인 성명

코드 냄새는 그냥 내 .

학점

사진 제공: Goh Rhy Yan on Unsplash

Programs, like people, get old. We can’t prevent aging, but we can understand its causes, limit its effects and reverse some of the damage.

마리오 푸스코

소프트웨어 엔지니어링 좋은 인용구

Maxi Contieri ・ 12월 28일 '20 ・ 13분 읽기

#codenewbie #programming #quotes #software

이 기사는 CodeSmell 시리즈의 일부입니다.

코드에서 냄새 나는 부분을 찾는 방법

Maxi Contieri ・ 2021년 5월 21일 ・ 7분 읽기

#codenewbie #tutorial #codequality #beginners