코드 냄새 148 - 할 일

우리는 미래의 자신을 위해 빚을 삽니다. 회수 시간입니다

TL;DR: Don't leave TODOs in your code. Fix them!



문제


  • 기술 부채
  • 가독성
  • 자신감 부족

  • 솔루션


  • TODO 수정

  • 문맥



    코드에서 TODO를 만납니다. 우리는 그들을 계산합니다.

    우리는 그것을 거의 다루지 않습니다.

    우리는 기술적 부채를 빚지기 시작했습니다.

    그런 다음 부채 +이자를 지불합니다.

    몇 달 후, 우리는 원래 부채보다 더 많은 이자를 지불합니다.

    샘플 코드



    잘못된




    public class Door
    { 
        private Boolean isOpened;
    
        public Door(boolean isOpened)
        {       
            this.isOpened = isOpened;
        }      
    
        public void openDoor()
        {
            this.isOpened = true;
        }
    
        public void closeDoor()
        {
            // TODO: Implement close door and cover it
        }      
    
    }
    

    오른쪽



    public class Door
    {
    
        private Boolean isOpened;
    
        public Door(boolean isOpened)
        {       
            this.isOpened = isOpened;
        }      
    
        public void openDoor()
        {
            this.isOpened = true;
        }
    
        public void closeDoor()
        {
            this.isOpened = false;
        }      
    
    }
    

    발각



    [X] 자동

    TODO를 셀 수 있습니다.

    태그


  • 기술 부채

  • 결론



    TODO를 셀 수 있습니다.

    대부분의 린터가 그렇게 합니다.

    줄이기 위한 정책이 필요합니다.

    TDD를 사용하는 경우 누락된 코드를 바로 작성합니다.

    이러한 맥락에서 TODO는 방문할 열린 경로를 기억하기 위해 깊이 우선 개발을 수행할 때만 유효합니다.

    더 많은 정보


  • Should you put ToDos?
  • Broken Windows Theory

  • 학점



    사진 제공: Eden Constantino on Unsplash

    After you finish the first 90% of a project, you have to finish the other 90%.



    마이클 아브라쉬






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


    좋은 웹페이지 즐겨찾기