JSDoc
JavaScript
の
関数 函数 function
などに特殊なコメントで説明を入れる
vscode VsualStudioCode
読み取り可能
Use JSDoc: Index
jsdoc/jsdoc: An API documentation generator for JavaScript.
code:sample.ts
/**
* Adds node to the tail of the linked list - O(1)
* @param {T} - value to add to list
* @return {void}
*/
description
変数
返り値
javascript - How to specify an array of objects as a parameter or return value in JSDoc? - Stack Overflow
object オブジェクト 型
の
array 配列 型
参考
JavaScriptでJSDocコメントを書くメリットとは - ICS MEDIA
https://google.github.io/styleguide/javascriptguide.xml#Comments
TypeScriptのJSDocサポートでできること、できないこと