코드 스멜 163 - 콜렉션 인 네임

CustomerCollection을 본 적이 있습니까?

TL;DR: Don't use 'collection' in your name. It is too abstract for concrete concepts.



문제


  • 가독성
  • 추상화 악용

  • 솔루션


  • 컬렉션의 이름을 특정 이름으로 바꿉니다.

  • 문맥



    명명은 매우 중요합니다.

    컬렉션을 많이 다루어야 합니다.

    컬렉션은 부재를 모델링하기 위해 null이 필요하지 않기 때문에 놀랍습니다.

    빈 컬렉션은 전체 컬렉션을 포함하는 다형성입니다.

    우리는 피하고 .

    에서 좋은 이름을 찾는 대신 좋지 않고 모호한 이름을 자주 사용합니다.

    샘플 코드



    잘못된




    foreach (var customer in customerCollection)
    {
        // iterate with current customer
    }
    
    foreach (var customer in customersCollection)
    {
        // iterate with current customer
    }
    

    오른쪽



    foreach (var customer in customers)
    {
        // iterate with current customer
    }
    

    발각



    [X] 반자동

    모든 린터는 이와 같은 잘못된 이름 지정을 감지할 수 있습니다.

    또한 잘못된 긍정으로 이어질 수 있으므로 주의해야 합니다.

    태그


  • 네이밍

  • 결론



    깨끗한 코드, 변수, 클래스 및 함수를 모두 관리해야 합니다.

    코드를 이해하려면 정확한 이름이 필수적입니다.

    처지







    더 많은 정보






    부인 성명



    코드 냄새는 그냥 내 .

    학점



    사진 제공: Mick Haupt on Unsplash


    Alzheimer's Law of Programming: Looking at code you wrote more than two weeks ago is like looking at code you are seeing for the first time.



    댄 허비츠






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


    좋은 웹페이지 즐겨찾기