[Clean Code] Comment Tags

[클린 코드] 코멘트 태그

프로그래밍에서 자주 사용하는 Comment 형식

 

 

「Comment Tags」 혹은 「Annotation Comments」 불리는데

코드 내에서 특정한 의미를 갖는 키워드를 포함한 주석

---

TODO (할일)

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

#TODO: 1차 Release 후 데이터 검증 로직 추가 필요

 

FIXME (수정 필요)

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

// FIXME: 이 함수는 특정 입력에서 예외가 발생할 가능성이 있음

HACK(임시 해결책)

// HACK: 임시로 sleep()을 넣어서 동기화 문제 해결 (근본적인 해결 필요)

XXX (위험 또는 경고)

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

// XXX: 보안 취약점이 있을 가능성이 있음, 점검 필요

 

git commit message나 작업 문서도 같이 남기면 좋겠지만
해당 키워드를 프로그래밍 분야와 조직 특성에 맞게 define 하고
코드 내 주석 형태로 남기면 유지보수 up

 

예를 들어, 해당 키워드로 전체 검색해 빠르게 refacotring 할 수 있다.

 

 

📌 클린 코드(Clean Code)란

클린 코드(Clean Code)란?

 

 

📌 [클린코드] 주석 Comment

[클린코드] 주석 Comment