댓글은 코드 냄새입니다. 게터는 또 다른 코드 냄새입니다. 뭔지 맞춰봐?

TL;DR: Don't use getters. Don't comment getters

문제

댓글 남용자

가독성

게터

솔루션

getter 주석 제거

게터 제거

문맥

수십 년 전에 우리는 모든 방법에 대해 논평했습니다. 사소한 것까지

주석은 중요한 설계 결정에 대해서만 설명해야 합니다.

샘플 코드

잘못된

pragma solidity >=0.5.0 <0.9.0;

contract Property{
    int private price;   

    function getPrice() public view returns(int){           
           /* returns the Price  */
        return price;
    }
}

오른쪽

pragma solidity >=0.5.0 <0.9.0;

contract Property{
    int public _price;   

    function price() public view returns(int){        
        return _price;
    }
}

발각

[X] 반자동

메서드가 getter이고 주석이 있는지 감지할 수 있습니다.

예외

함수에 주석이 필요합니다. 이는 실수로 getter이고 주석은 디자인 결정과 관련이 있습니다.

태그

댓글

결론

게터에 주석을 달지 마십시오.

실제 가치를 추가하지 않고 코드를 부풀립니다.

처지

코드 냄새 05 - 댓글 남용자

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

#codenewbie #tutorial #beginners

코드 냄새 68 - 게터

Maxi Contieri ・ 2021년 4월 29일 ・ 2분 읽기

#codenewbie #tutorial #oop #programming

코드 냄새 01 - 빈혈 모델

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

#codenewbie #oop #beginners #computerscience

학점

Reimond de Zuñiga의 Unsplash 사진

Code should be remarkably expressive to avoid most of the comments. There'll be a few exceptions, but we should see comments as a 'failure of expression' until proven wrong.

로버트 마틴

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

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

#codenewbie #programming #quotes #software

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

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

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

#codenewbie #tutorial #codequality #beginners