일상기록/IT공부

좋은 코드란 무엇인가? | 코드잇 강의노트

책읽고글쓰는새댁 2021. 1. 7. 23:47

 

코딩공부를 하면서 기억하고 싶은 썸머리를 메모해 보려고 합니다.👏👏

 

 

 

//

좋은 코드란

컴퓨터 뿐만 아니라 함께 일하는 혹은 정보를 공유하는 개발자 간에 잘 읽히도록 짜여진 코드 라고 합니다.

 

 

개인적으로 참고할 메모를 위한 목적이 더 크니, 편의상 맺음말을 편하게 쓰겠습니다😉

 

 

 

//

 

1. 읽기 쉬운 "가독성"이 좋은 코드를 말한다.

개발자 간에 소통하기 쉽도록 가독성이 좋아야 하는데, 가독성을 높이는 방법은?!

Commend를 활용해 덧붙혀 설명하는 것.

 

코멘드는

컴퓨터는 코멘드 된 내용을 프로그래밍으로 이해하지 않지만 

나만의 메모 일 수도 있고,

협업 시 코드에 대한 첨부설명이나 약속일 수 있다.

 

코멘드를 표기하는 방법은 프로그래밍 언어마다 다르다! 

 

 

 

//

 

2. 이름을 잘 지어야 한다.

전체적인 코드의 흐름 안에서 너무 짧지도 길지도 않은 적당히 작명하는 센스가 필요함!

변수의 이름을 적을때 띄어쓰기를 표기하는 방법들이 다르다.

 

donor_name : snake표기법 (언더바 사용)

DonorName : pascal표기법 (단어 첫철자 대문자표기)

donorName : camel표기법 (띄어쓰기 하는 첫 철자 대문자표기)

 

 

 

 

 

 

이름이든 코멘트든 전체적인 코드의 흐름 안에 일정한 규칙을 정해두고 코딩을 할 것. 

 

 

 

 

 

//

 

3. 권장 스타일 가이드를 참고하기

예를들어 구글에 <phython style guide> 라고 검색해 보면 파이썬에서 권장하는 스타일 가이드를 찾을 수 있다.

 => PEP8 (Python Enhance Proposal 8)

 

그런데 바로가는 링크를 첨부해두었지,

아래 링크로 꼬고우

PEP 8 -- Style Guide for Python Code | Python.org

 

 

 

가이드 중 한가지는 

변수 이름으로는 l(소문자 엘), O, I(대문자 아이) 단독 이름을 쓰지는 말라는 것,

L과 i 가, 알파벳 O와 숫자 zero 간에 헷갈릴 수 있기 때문!

 

 

 

이와 같이 언어마다 권장 스타일 가이드가 있고,

사용자(개발자, 개발팀, IT기업)마다 특정 부분에 더 집중한 가이드가 있기도 하다.

 

협업하는 팀에서 일정한 가이드가 있다면 그 가이드에 따르면 될 것이고,

개인적으로 작업을 하거나,

포트폴리오를 구성중이라면 이런 권장 가이드에 따르는 것이 좋을 것 같다!

 

 

 

다 외울 필요는 없지만 코딩할 때 스타일가이드를 잘 지켜야지 인식하는 것이 좋은코드를 만드는 기본이 될 수 있음!!

 

 

 

 

 

 

 

 

 

스타일 가이드를 잘 지켜서 좋은 코드를 만들어봅시다! 🐱‍🚀🤳