Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dynamis opened this issue Oct 2, 2018 · 0 comments
Open

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

dynamis opened this issue Oct 2, 2018 · 0 comments
Labels
enhancement polyfill WebAPI polifill 関連
Milestone

Comments

@dynamis
Copy link
Contributor

dynamis commented Oct 2, 2018

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

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

具体的には次のように書くって話です via 43187e2

/**
 * 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);
  });
}
@dynamis dynamis added enhancement polyfill WebAPI polifill 関連 labels Oct 2, 2018
@dynamis dynamis added this to the Future milestone Oct 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement polyfill WebAPI polifill 関連
Projects
None yet
Development

No branches or pull requests

1 participant