쓸데없는 말 작작 해라

1317 단어
이것은 직접 본 소절의 코드인데, 독후감은 단지 네 글자뿐이다. 쓸데없는 소리 하지 마라!
//       ，        
int maxStudent(int student[], size_t arraySize) {
    //          -1
    int maxValue = -1;
    
    //       ，     
    for (size_t i=0; i<arraySize; ++i) {
        //               
        if (student[i] > maxValue) {
            //         
            maxValue = student[i];
        }
    }

    //         
    return maxValue;
}

이런 주석은 수다스럽게 코드를 다시 한 번 반복하고 읽는 사람의 읽는 양을 늘리는 것 외에는 아무런 유익한 작용도 하지 못했다.이 코드는 빈틈이 없지만 지루하고 쓸모없는 주석이 이 모든 것을 완전히 파괴했다. 만약에 사용한 주석을 모두 없애면(함수 기능을 표현하는 그 문장 제외) 가독성이 오히려 크게 높아진다.
//  student       
int maxStudent(int student[], size_t arraySize) {
    int maxValue = -1;
    for (size_t i=0; i<arraySize; ++i) {
        if (student[i] > maxValue) {
            maxValue = student[i];
        }
    }
    return maxValue;
}

현재 남은 유일한 유감은maxStudent라는 함수명이 명확하지 않다는 것이다. 우리는'값'이 학생의 성적을 가리키는지, 아니면 학생의 학번을 가리키는지, 또는 학생의 키와 몸무게를 가리키는지 알 수가 없다. 만약에 이 함수명이 더 잘 되면 문제를 직접 설명할 수 있다면 함수 기능이라는 주석도 없앨 수 있다.
원칙:
  • 좋은 코드는 스스로 주석한 것이다.
  • 주석은 문제를 해결하는 방법을 설명하는 것이 아니라 해결해야 할 문제를 설명해야 한다.
    • Windows 10에 Miniconda3 설치
    ZOJ_1091-Knight Moves

    좋은 웹페이지 즐겨찾기

    개발자 우수 사이트 수집

    개발자가 알아야 할 필수 사이트 100선 추천 우리는 당신을 위해 100개의 자주 사용하는 개발자 학습 사이트를 정리했습니다
    best100-homepage