[VIM] 주석 TODO, FIXME, XXX, NOTE

참고

[vim] TODO, FIXME, XXX 태그의 의미

아무런 처리를 해주지 않아도, 기본적으로 하이라이트 표시되는 키워드들이 있다.

꼭 vim으로 보지 않아도 확인할 수 있는데, 예를 들면 vscode에서 파이썬 파일에 #TODO 와 같이 쓰면 TODO 글씨의 색이 바뀐다. 특정한 의미를 가진 키워드로 사용되기 때문에 그렇다. 말그대로 하이라이트가 되는 경우도 있고, 그냥 글씨의 색이 바뀌는 경우도 있다. 이건 에디터마다 조금 다른 것 같다.

 

아래는 default 설정된 태그들이다.

 

1) TODO : 좀더 최적화시키고 리팩토링시킬 수 있을만한 구석이 있을때. 미래에 뭔가 의미있는 작업을 더 해야 할 필요성을 느낄때.

2) FIXME : 문제가 있는것이 확실하지만, 그걸 지금 당장 그것을 수정할 필요는 없을 때.

3) XXX : 해당 부분에 대해서는 더 생각해볼 필요성이 있을 때. 또는 해당 부분에 질문이 생길 때. 또는 코드에서 문제가 일어날만한 부분을 강조 표기할때. 완벽하게 정확히 구현되지 않은 부분이 있을 때. 나중에 고쳐야만하는 부분일 때.

 

직접 태그를 추가할 수도 있고 하이라이트 설정도 할 수 있다.

 

1) 하이라이트 설정 참고

https://stackoverflow.com/questions/4097259/in-vim-how-do-i-highlight-todo-and-fixme

In vim, how do I highlight TODO: and FIXME:?

2) 태그 추가 참고

https://lowlevel.tistory.com/15

TODO, FIXME, XXX 태그의 의미