함수에 주석 달기에 대한 생각

코딩을 하는데 함수 시그니쳐만으론 어떤 예외가 발생하는지 통 알 수가 없으니, std::exception으로 모든 예외를 잡는 상황이 종종 있었다. 

boost의 소스 코드는 발생하는 예외에 대해선 @throws [발생하는 예외의 종류] 같은 식으로 명시를 해놓았더라. 덕분에 어떤 예외가 발생하는지 파악하기 쉬웠다. 아쉬운 점이라면, 주석이 너무 빡빡하다는 점. 디테일한 설명을 하는 것도 장점도 있으니 이 부분은 취향 차이라고 본다.

나도 이 부분을 본받아서 주석을 달면 좋겠다는 생각을 했다. 

이런식으로 주석을 작성하면, ide 단에서 함수의 설명은 다음과 같이 나온다. 

그리고, ide 단에서 발생하는 예외에 대해서도 표시를 해줬으면 좋겠다. 지금 막 작성하는 코드에도 주석을 꼼꼼히 달면서 하긴 어려운데, 보다 파악이 쉬워지지 않을까?