코드 냄새 99 - 첫 번째 두 번째

게으른 인수 이름을 몇 번이나 볼 수 있습니까?

TL;DR: Name your arguments according to the role and not the accidental position



문제


  • 가독성
  • 의도를 드러내는 이름

  • 솔루션


  • 의미 있는 이름 사용

  • 문맥



    메서드를 작성할 때 일반적으로 적절한 이름을 찾기 위해 멈추지 않습니다.

    우리는 명백한 것을 리팩토링하지 않습니다.

    샘플 코드



    잘못된




    class Calculator:
      def subtract(self, first, second):
        return first - second
    
    class CalculatorTest:  
      def test_multiply():
        assert equals(first, second)
    

    오른쪽



    class Calculator:
      def subtract(self, minuend, subtrahend):
        return minuend - subtrahend
    
    class CalculatorTest:  
      def test_multiply():
        assert equals(expectedValue, realValue)
    

    발각



    [x] 수동

    인수 이름으로 'first' 및 'second'와 같은 금지된 단어에 대해 경고할 수 있습니다.

    태그


  • 가독성

  • 결론



    항상 규칙 제안 매개변수를 따르십시오.

    역할에 따라 공동 작업자의 이름을 지정하십시오.

    처지







    더 많은 정보






    학점



    사진 제공: Priscilla Du Preez on Unsplash


    Final source code is the real software design.



    잭 리브스






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


    좋은 웹페이지 즐겨찾기