[읽기 가능한 코드] 코드를 잘 쓰는 원칙[상급편]

나는 지금까지 리더십 코드를 쓴 적이 있는데 이번이 마지막이다.
이번에는 더 깊이 들어가고 규모가 큰 변경 아이디어에 대해 해설한다.
구체적으로 말하면

함수에서 유니버설 코드 추출

매번 한 가지 일만 한다

알기 쉬운 짧은 사이즈

쓰기
라고 세 가지 해설을 내놨다.

1. 함수에서 유니버설 코드 추출

함수에는 주요 목적과 무관한 처리를 반드시 써야 할 때가 종종 있다.
예를 들어 두 거리를 계산하는 함수가 존재한다고 가정한다.
이때 한 값의 단위가 km이고 다른 값의 단위가 cm라면 단위를 조정해야 한다.
즉, 이 함수의 주요 목적은 두 개의 거리를 계산하여 단위가 일치하는 처리를 주요 목적과 무관하게 하는 것이다.
따라서 이 단위를 중합시키는 처리를 다른 함수로 차단하는 것이 좋다.
이런 처리를 함수로 분리해서 끊으면 코드의 전망이 더욱 좋아질 것이다.
또 이번처럼 통용되는 처리 상황에서도 다른 함수에서 호출할 수 있다.
즉, 함수에서 범용 코드를 추출하여 DRY의 원칙을 따르는 코드를 작성할 수 있습니다.
다만, 너무 많이 하면 당연히 역효과를 볼 수 있다.
작은 단위로 함수를 자꾸 추출하면 코드의 전망이 오히려 나빠진다.
또 통용되지 않는 코드를 추출하는 것도 좋을 게 없다.
따라서 이 점에 유의할 필요가 있다.

2. 한 번에 한 가지 일

"함수가 한 가지만 하게 해주세요".
이런 조언 많이 들었죠.
이번에 소개한 것은 그것과 같은 생각이다.
하고 싶은 일이 섞인 함수는 이해하기 어렵다.
따라서 이 함수에서 진행된 일을 먼저 열거한다.
그리고 아까 소개한 대로 통용할 수 있는 물건이 있으면 추출해 보세요.
그 다음에 각 처리에 따라 단락을 나누어 낙서하면 완성된다.
나는 이렇게 하면 비교적 쉽게 읽을 수 있을 것이라고 생각한다.
이처럼 한 번에 여러 가지 일을 하면 이해하기 어렵기 때문에 분리해서 생각하는 것이 중요하다.

3. 간단하고 알기 쉽게 짧은 코드를 쓴다.

할머니가 똑똑히 설명하지 못하면 정말 이해한다고 할 수 없다.
이것은 아인슈타인의 말이다.
프로그램을 쓸 때도 같은 의식을 가져야 한다.
할머니는 물론 처음 엔지니어라도 알 수 있는 코드에 주의해야 한다.
그리고 이 목표를 달성하기 위해 지금부터 실시될 내용을 언어로 표현해 보는 것도 중요하다.
예를 들어 유료 회원의 한정된 이미지를 표시하는 페이지는 다음과 같다.

//APIからユーザーデータを取ってくる

//APIからの結果を正常と異常に分けて処理する

//異常な場合はエラーメッセージを書く

//正常な場合はユーザーの権限を見る

//権限があった場合は限定画像をリサイズして表示する

//権限が無かった場合はその趣旨を画面に表示する

이렇게 한 번 말로 하면 이해하기 쉬워진다.
또 코드를 쓸 때는 양을 최대한 줄여야 한다.
이번 예로 사용자의 권한을 확인하는 데 유니버설 함수로 추출할 수 있다.
또한 프로그램 라이브러리를 사용하면 이미지 크기를 간단하게 조절할 수 있다.
프로그래머가 가능한 한 적은 코드로 실현하는 방법을 고려하는 것도 중요하다.
애플릿의 유지 보수 비용이 비교적 적기 때문이다.

끝말

읽을 수 있는 코드를 세 부분으로 나누어 설명하다.
이번에 쓴 내용만 의식하면 상당히 좋은 코드를 쓸 수 있다.
나도 매일 공부하고 더 좋은 코드를 쓰기 위해 노력하고 싶다.
또한 제 블로그에는 React 엔지니어가 되는 로드맵이 무료로 공개되어 있으니 참고하시기 바랍니다.백엔드 엔지니어가 되고 싶은 사람에게도 도움이 된다는 메시지가 적혀 있다.
https://hinoshin-blog.com/react-roadmap/
끝맺다