項目68 APIのコメントにTSDocを使う
エクスポートされた関数、クラス、型のドキュメントを書く際は、JSDoc・TSDoc形式のコメントを使用する。そうすることでエディタによる補助を受けれる
code:js
/**
* あいさつ文を作る。
* @param name あいさつする相手の名前
* @param title あいさつする相手の肩書き
* @returns 読みやすいようにフォーマットされたあいさつ文
*/
function greetFullTSDoc(name: string, title: string) {
return Hello ${title} ${name};
}
https://scrapbox.io/files/683a5791737dc22e649682d0.png
@paramや@returns、フォーマットのためのマークダウンを使用する
型情報をドキュメントに含めることは避ける