last updated: 210518 by soyeonkim

원문 : https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be

코드리뷰문화(뱅크샐러드)

읽기전에 용어 확인

• magic number : 소스코드에서 숫자를 직접적으로 사용하는 것으로 의도 파악이 잘 안되는 하드코딩된 숫자값인 것 같아요!
• [guard clause](https://blog.fakecoding.com/archives/guard-clause#:~:text=guard clause로 처리하는,실행되지 않도록 하는것입니다.): 사전 조건이 거짓이라면 ( 다음 단계로 진행하기 위한 올바른 실행 조건이 아니라면 ) 예외처리를 하여 더이상 다음 단계가 실행되지 않도록 하는것입니다
• readibility : 읽기 좋은 코드

목차

• 변수명
• 코드 리뷰 룰

변수명에 관하여

원문의 저자는 연구 중심의 data science code에서 production level 코드를 보며 공부했지만, 그러한 책이나 자료들로부터 떨어져서 programming 을 늘려야했다고 합니다. 첫번째 snippet으로부터 두번째 snippet까지 가기 위한 저자 내용을 정리합니다. 중간중간 동의되지 않더라도 constant 한 규칙을 정하는 것을 강조하네요.

• original code (뭘 계싼하는 코드인지 전혀 알 수 없음)

for i in range(n):
    for j in range(m):
        for k in range(l): 
            temp_value = X[i][j][k] * 12.5
            new_array[i][j][k] = temp_value + 150

• 수정 후

PIXEL_NORMALIZATION_FACTOR = 12.5
PIXEL_OFFSET_FACTOR = 150

for row_index in range(row_count):
    for column_index in range(column_count):
        for color_channel_index in range(color_channel_count):
            normalized_pixel_value = (
                original_pixel_array[row_index][column_index][color_channel_index]
                * PIXEL_NORMALIZATION_FACTOR
            )
            transformed_pixel_array[row_index][column_index][color_channel_index] = (
                normalized_pixel_value + PIXEL_OFFSET_FACTOR
            )