Parameter id is not described in JSDoc

controller.ts 파일에서 @Get() 메소드 위에 Todo문 하나를 작성해놓은 상태였다. 

  /**
   * Todo: 팝업 한 개 반환 API
   * @param dto
   */
  @ApiTags('팝업 한 개 반환 API')
  @Get('/:id')
  async getOnePopup(@Param('id') id: string) {
    return Response.okWith(await this.popupApiService.getOne(id));
  }

그런데 @Param('id') id:string 부분에서 노란색으로 감싸져있어서 마우스를 올려보았더니, Paramter id is not described in JSDoc 이라는 문구가 출력되었다. 

JSDoc이 뭐지.. JSDocument의 줄임말인가?하고 생각해보며 구글링을 했다. 

JSDoc은 말 그대로 JS의 레퍼런스를 뜻하며, Javascript 파일에 타입 정보 제공을 위해 제공된다고 한다. 자바스크립트 소스코드에 타입 힌트를 제공할 수 있다고 한다. 

 

내가 위에서 작성한 Todo문도 JSDoc의 일종이었다..! 

그래서 id에 대한 정보가 Todo문에 없기 때문에 Parameter id is not described in JSDoc 이라는 경고문이 출력되지 않았을까 싶다. 

 

해당 경고문은 Todo문을 삭제해주거나 or Todo문 안에 id에 대한 type을 기술해주면 사라진다 :)