[CleanCode]좋은 주석

 

법적인 주석

이와 같은 소스 파일 첫머리의 저작권/소유권 정보

---

정보를 제공하는 주석

이 주석 말고 밑에 봐주세여

String text = "The event starts at 12:34:56 Monday, September 19, 2024."; 여기에서 정규식 Pattern에 맞는 부분만 찾아 출력합니다.

 

이런 식으로 정규식을 찾는 Pattern이 어떤 형식을 찾는 지 적어줄 수 있습니다.

---

의도를 설명하는 주석.
의도를 명료하고 밝히는 주석.

---

결과를 경고하는 주소

예전에는 이러한 너무 시간이 오래 걸리는 코드를
메서드 이름 앞에 _ 를 붙이는 게 관례였다고 한다.

요즘에는 @Ignore 속성에 문자열로 넣어준다고 한다.
ex:  @Ignore("실행이 너무 오래 걸린다.")
(Junit을 추가하거나 Maven프로젝트에서 사용 가능함)

---

TODO / FIXME 주석

프로젝트를 진행하다보면..아직 어떻게 진행할 지 정해지지 않은 부분들이 있습니다.

이런 경우에 TODO주석을 달아 둡니다.

따라서 TODO /  FIXME 주석은 꼭 필요하고 확인해야할 주석입니다.

---

중요성을 강조하는 주석