chirimen-oh / chirimen

CHIRIMEN for Raspberry Pi
https://chirimen.org/chirimen/
13 stars 17 forks source link

jsdoc コメントを付けたい #49

Open dynamis opened 5 years ago

dynamis commented 5 years ago

polyfill などのコードで関数定義の上にその関数と引数、返り値などの説明を jsdoc 形式で付け足して、開発時にツールチップ表示されたり API ドキュメント作ったりが出来る形にしたい。

したいなと思ったので issue は立てますが全然急ぎのことではないので Future マイルストーン付けます。

具体的には次のように書くって話です via https://github.com/chirimen-oh/chirimen-raspi3/commit/43187e26dc6be5e989c27ee0d3f85200369482f9

/**
 * Utility function for async/await code.
 * @param {number} ms - milliseconds to wait
 * @return {Promise} A promise to be resolved after ms milliseconds later.
 */
function sleep(ms) {
  return new Promise(function(resolve) {
    setTimeout(resolve, ms);
  });
}