클린코드 작성법 (1)

Jiwon·2021년 5월 1일
0

클린 코드 원칙

목록 보기
1/6

스파르타코딩 수업에서 '개발자의 필수 개념' 코스를 수강 중이다.
배운 내용을 토대로 정리해 보고자 한다.

언어는 Python이고 IDE는 PyCharm를 이용한다.

클린코드를 작성하기에 앞서 어떻게 실행되는지 보자.

가상환경이 셋팅되고 실행되는데
가상환경이란 프로젝트 별로 패키지들을 담을 공구함을 의미한다.

venv폴더에 라이브러리와 코드를 미리 저장하고
각 프로젝트 별로 가상환경을 분리하게 되면 매 프로젝트마다 필요한 패키지들을 관리하고 사용 가능하다.

위의 화면은 파이참을 실행한 화면인데
맨 윗줄이 어떤 파일을 실행했다.
두 번째 줄이 결과 값
세 번째 줄이 정상적으로 실행됬다.
라는 의미를 가지고 있다.

이제 클린코드에 다가가 보자.

변수명은 주석으로 변수명을 설명해서는 절대 안된다.

길어지더라도 명확한 변수명을 작성해야 한다.
그래도 너무 과하지 않게 30글자 이내로..

IDE의 장점이란 바로 편리성.
변수명들을 한 번에 바꾸고 싶으면 rename을 이용하자.
단축키로는
윈도우 : shift + F6
MacOS : fn + shift + F6

( control + g : 같은 이름을 지우고 다시 쓸 수 있다. )

rename 해주고

조건의 기준이 되는 것은 기준이 바뀔 수도 있기 때문에 변수에 담아 주는 것이 좋다.
즉, 상수들은 변수로 지정하는게 더 좋다는 뜻

상수값을 변수에 담기 위해서는 대문자로 표현하는 경우가 대부분.

결과 값이 boolean값이 오면 is 접두사를 이용해서 써준다.
그래야 return값이 참, 거짓을 구한다는 것을 유추할 수 있다.
조건문에 Pass가 있는 경우는 아무것도 하지 않고 지나간다는 뜻이다.

주황색 밑줄은 에러는 아니고 코드의 기준 폼과 맞지 않아서 그렇다.
포맷코드를 눌러주면 해결 :)
초록색 밑줄이 뜰 경우는 더 올바른 영단어를 권장 하는 것이다.

만약 간격 조절하고 싶으면
shift + tab 으로 간격 조절 가능

클린코드를 적용하기 전, 후를 살펴보자


클린코드 전의 코드.
의도를 파악하기 힘들다.


클린코드 후의 코드.
변수명과 함수명으로 어떤 코드인지 추측이 가능하다.

참고로 결과창은 신경쓰지 말 것.

profile
과연 나는 ?

0개의 댓글