IT&Computer

좋은 코드 나쁜 코드가 따로 있을까? 좋은 코드 작성 방법

Seeker시커 2023. 7. 28. 07:00
반응형

코드에도 좋은 코드, 나쁜 코드가 따로 있을까?

단순히 기능이 잘 작동하는 코드가 좋은 코드가 아니다.개발자들은 프로그래밍 언어를 통해서 컴퓨터에게 정확한 명령을 내리는 것도 중요하지만, 다른 개발자와 코드를 통해서 소통하는 것도 중요하기 때문이다. 좋은 코드란, 다른 사람이 봤을 때도 잘 이해되는 코드라고 할 수 있다. 

좋은 코드 나쁜 코드가 따로 있을까? 좋은 코드 작성 방법

MART PRODUCTION님의 사진: https://www.pexels.com/ko-kr/photo/7172094/


좋은 코드를 쓰는 방법은 프로그래밍 언어를 잘 활용하는 방법과 같다고 할 수 있다.

좋은 코드를 작성하기 위한 방법은 무엇이 있을까?

 

1. 코멘트 Comment

코멘트는 컴퓨터에게 전하는 명령이 아닌 다른 사람들에게 전하는 말이다. 각 코드에 기능과 주의할 점을 기록함으로써 코드의 가독성을 높일 수 있다. 하지만 너무 많은 코멘트를 남발하게 되면 오히려 보기가 어렵기 때문에 주의해야 한다. 프로그래밍 언어마다 코멘트를 삽입하는 문법이 다르다. (Python : #, C : //)

 

2. 변수/함수의 이름 잘 짓기

프로그래밍을 하면서 모든 변수와 함수의 이름을 지어야 한다. 이때 너무 일반적이거나 너무 구체적인 이름을 짓지 않도록 주의해야 한다. 너무 일반적인 이름을 지으면 변수/함수가 의미하는 바를 알기 어렵기 때문에 적당히 의미를 담을 수 있도록 해야한다. 하지만 너무 구체적으로 지으면 사용하기도 불편하고 읽기도 어렵다. 전체적인 코드를 고려해서 충분히 구체적이되 간결한 이름을 지어야 한다.

3. 스타일 가이드 활용

각 프로그래밍 언어는 코드를 작성하기 위한 스타일 가이드를 제공한다.

예를 들어 변수/함수의 이름에서 띄어쓰기는 어떻게 표현하는지, 코멘트는 어디에 입력하는지 등에 대한 가이드이다. 스타일 가이드를 따르지 않는다고 코드가 작동하지 않는 것은 아니다. 하지만 여러 사람이 협업해서 프로그램을 만들 때 스타일 가이드를 준수함으로써 전체 코드의 가독성을 높일 수 있다.

언어 스타일 가이드
Python https://www.python.org/dev/peps/pep-0008/
JavaScript https://standardjs.com/
Java https://www.oracle.com/technetwork/java/codeconvtoc-136057.html

각 언어 제작사 뿐 아니라 구글 등의 IT 기업에서 제공하는 스타일 가이드도 있다.

 

 

 

좋은 코드 나쁜 코드가 따로 있을까? 좋은 코드 작성 방법

 

 

 

※ 이 포스트는 내돈내산 코드잇 강의 내용을 기반으로 작성되었습니다.

반응형