[Typescript] 주석 사용법

협업을 하다보면 자연스레 내가 만든 함수를 다른사람이 봐야할 수도 있고 설명이 필요할 수가 있다.

 

이때 유용한 주석표기법에 대해 공유하려고 한다. 

/** 인사말을 생성합니다. 결과는 보기 좋게 꾸며집니다.  
 * @param name 인사할 사람의 이름
 * @param title 그 사람의 칭호
 * @returns 사람이 보기 좋은 형태의 인사말 
*/
function greetJSdoc(name: string, title : string){
    return 'Hello';
}

greetJSdoc('John Doe', 'Sir');

이런식으로 사용하면 함수이름에 마우스를 올려놓거나, 매개변수에 마우스를 올려놓았을 때 관련 설명을 볼 수 있다.

 

마크다운 형식으로 꾸며지기 때문에 굵은 글씨로도 표현할 수 있다.