[공부 필기] JavaScript 문법 공부 5일차

※ 필자는 자바스크립트 초보자입니다

※ 피드백/잘못된 사항 지적은 언제든지 환영합니다

 

---

 

왜 다시 공부를 시작했는지 등은 이전 글을 참고

2022.02.19 - [2. 개발 공부/JavaScript] - [공부 필기] JavaScript 문법 공부 1일차

[공부 필기] JavaScript 문법 공부 1일차

 

1. 이 글은 이렇게 작성될 계획..

너무 좋은 자료(https://ko.javascript.info/)에, 너무 좋은 필기들, 너무 좋은 댓글들이 이미 있기 때문에

별도로 필기를 하며 공부하지는 않고 그냥 글을 쭉쭉 읽어가면서

더 추가적으로 공부한 내용이나, 개인적으로 필기해놓고 싶은 내용, 실습해보기 위해 작성해본 소스코드 등만 본 글에 필기할 계획이다.

 

---

- 주석(comment)

공부 자료 출처 : https://ko.javascript.info/comments

주석

문법도 중요하지만 코딩을 진심으로 오래하려면 코드 품질을 고민하는 것도 중요하다고 생각한다.

그래서 여전히 코드 품질에 대해서 공부하고 있다.

 

위의 글에서는 좋지 않은 주석에 대해서 설명해주고 있다.

그 예시로 아래와 같은 내용들이 있었다.

 

1> 설명이 줄줄이 길게 적힌 주석은 좋지 않다. 일단 그런 코드는 좋은 코드가 아니다.

주석으로 줄줄이 설명을 적어야하는 코드는 좋은 코드가 아니라고 한다.

좋은 코드는 주석이 없어도 코드 자체만으로 어떤 역할을 하는지 쉽게 이해가 되어야 한다고 한다.

코드가 너무 불분명해서 주석 작성이 불가피 하다면 코드를 다시 작성하는것도 괜찮은 방법이라고 한다.

 

코드를 다시 작성한다니.. 리팩토링을 얘기하는건가.

왜냐하면 그 뒤에 서술된 내용이 리팩토링 팁이기 때문이다.

※ 리팩토링 : 결과의 변경 없이 코드의 구조를 재조정함 (출처 : 위키백과)

 

2> 리팩토링 팁 : 함수 내 코드 일부를 새로운 함수로 옮기는게 유익할 때도 있다.

함수를 역할/기능에 따라 함수로 분리하라는 의미 같다.

또한 코드를 세로로 길게 쭉 늘려뜨리는 것보다는 함수로 잘 나눠서 사용하는게 좋다고 한다.

이때 함수는 주석 없이도 그 존재 자체가 무슨 역할인지 설명이 되어야 한다.

그래서 함수를 기능에 맞게 나눠서 만드는거기도 하고, 함수명을 직관적으로 쓰는 것이기도 한 듯 하다.

 

3> 코드에 대한 설명이 꼭 필요하다면 주석을 적으면 된다.

하지만, 이 경우는 정말 불가피하게 필요한 경우이다.

자료에서는 '알고리즘이 복잡한 코드를 작성하는 경우' 혹은 '최적화를 위해 코드를 약간 비틀어 작성한 경우' 등이라고 설명해주고 있다.

 

4> 좋은 주석 : 아키텍처를 설명하는 주석은 좋은 주석이다.

'이 함수는 무슨 기능을 하는 함수' 등을 적는 것보다는 아키텍처를 주석으로 적는게 좋다고 한다.

"고차원 수준 컴포넌트 개요, 컴포넌트 간 상호작용에 대한 설명, 상황에 따른 제어 흐름 등"이라고 적혀 있는데...

어떤 것인지 많은 코드를 보고 배우며 익혀야할 것 같다.

어쨌든, 이 아키텍처를 다이어그램으로 이해하기 위해서 UML을 공부하는 것도 추천한다고한다.

 

5> 좋은 주석 : 함수 용례와 매개변수 정보를 담고 있는 주석은 좋은 주석이다.

JSDoc이라는 문법을 사용하면 함수에 관한 문서를 쉽게 작성할 수 있다고 한다.

 

6> 좋은 주석 : 왜 이런 방법으로 문제를 해결했는지 설명하는 주석이 좋은 주석이다.

"무엇이 적혀있는지"가 중요하다고 한다.

코드를 볼 때,

왜 이 문제를 이런 방법으로 해결했는지를 파악하려면 그렇게 주석을 써주는게 좋다고 한다.

만약 아주 오래전에 만든 코드가 있고 거기에 '왜 꼭 그 방법으로 코드를 써야했는지'에 대해서 주석이 달려있으면

미래의 누군가가 그 코드를 개선할 때 시간을 낭비하지 않을 수 있다고 한다.

 

7> 미묘한 기능이 있고, 이 기능이 어디에 쓰이는지 설명하는 주석이 좋은 주석이다.

직감(?)에 반하는 미묘한 동작을 수행하는 코드가 있다면 주석을 달아주는게 좋다고 한다.

근데, 코드를 작성하는데 있어서 직감(?)에 반하는 미묘한 동작을 하는 경우가 있는걸까...?