[코드주석] TODO / FIXME / XXX 이란?

협업을 하다보면 다른 작업자가 써놓은 주석을 종종 보게된다.

(근무회사에서는 작업자 본인이 추후에 작업사항이 필요하거나 다른 작업자에게 작업을 요청할 경우에 보통쓰였다.)

 

FIXME
TODO
XXX

 

무언가 작업을 해야될 필요성이 있으므로 추후에 해야된다고만 생각했었다.

이번 정리를 통해 둘의 차이점과 의미를 확실하게 알고 넘어가자!

 

(결론 : 단순 주석보다는 의미있는 주석을 남기는 습관을 들이자!!👍)

---

TODO

당장 구현하기는 어렵지만 추후에 작업이 필요한 사항.

추후에 무언가 더 의미있는 작업을 해야될 필요성이 느껴지는 사항. (ex. 최적화, 리팩토링)

 

FIXME
문제사항이 있는건 확실하지만, 당장 수정할 필요는 없는 사항.

 

XXX

해당 부분에 대하여 더 생각해볼 필요성이 있는 사항.

(근무한 회사 내 코드에서는 보지 못했다.)

 

c.f) 경우에 따라 다르겠지만 @TODO의 빈도수가 가장 높다고 한다.

---

VS Code 사용자라면 아래 Extension을 다운받는 걸 추천한다.

 

marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight

TODO Highlight - Visual Studio Marketplace

---

참고

egloos.zum.com/rucaus/v/2455594