코드 주석

 

코드 주석이란 프로그래밍에 있어 내용을 메모하는 목적 으로 쓰이는 것이다.
소스 코드를 이해할 수 있게 도와주며 코드 실행 시 영향을 주지 않는다.

 

나는 이러한 이유 때문에 코드 작성 시 주석을 많이 사용했었지만
너무 남용하고 알맞게 사용하지 못하고 있었다

 

---

잘못된 주석

1. 사용하지 않는 코드 주석

// import {useSelector, useDispatch} from 'react-redux';
// import {
//   addTodo as addTodoActionCreator,
//   removeTodo as removeTodoActionCreator,
//   removeAll as removeAllActionCreator,
// } from '../redux/slices/todoSlice';

나는 사용하지 않는 코드라도 현재 코드와 비교할만한 거리면 주석을 처리하여 남겨두었는데
가독성을 해치고 예기치 못한 오류를 발생시킬 수 있다고 한다.

 

 

2. 코드를 설명하는 주석

// login page에 대한 내용
const lp = () => {
...

함수나 변수명을 이해하기 어려운 방식으로 지어놓고 주석을 다는 것은 잘못된 코드이다.
명확하게 이름을 지어야 처음 보는 사람도 한 번에 이해할 수 있으며 이런 경우 주석을 다는 것보다
코드를 새로 짜는 게 더 좋다.

 

---

 

좋은 주석

1. 함수나 변수 목적을 나타낸 주석

// 로그인
app.post('/login' ,()=>...

// 회원가입
app.post('/signup' ,()=>...

// 탈퇴
app.delete('/delete' ,()=>...

함수나 변수의 목적을 간략하게 나타내면 다른 사람이 봐도 한 번에 이해할 수 있다.
특히 코드가 길어질 경우 가독성을 향상시키고 유지보수를 용이하게 한다.

 

2. TODO 주석

// TODO : 여기에 에러처리를 해야함
const err = (e) => {

앞으로 작업을 해야 하는 부분이나 수정이 필요한 곳에 TODO 주석을 남기는 것도 좋은 방법이다.
자신이 작업할 내용을 찾거나 협업시 다른 팀원에게 필요한 작업을 전달하는 데도 유용하다.

 

---

🤔느낀점

사실 제일 좋은 건 주석을 사용할 필요가 없을 정도로 좋은 코드(쉬운 코드)를 짜는 것이다.
하지만 이건 나에게는 너무 어려우니 주석을 알맞게 사용하는 연습을 해야겠다 😅😅
특히 이번에 TODO 주석은 첨 알게 되었는데 앞으로 유용하게 사용할 수 있을 거 같다!!

 

 

[참고]

https://ko.wikipedia.org/wiki/%EC%A3%BC%EC%84%9D_(%ED%94%84%EB%A1%9C%EA%B7%B8%EB%9E%98%EB%B0%8D)
https://ittrue.tistory.com/375