Sitelet https://web.archive.org/web/20201231110648/https://github.com/nodejs/node-addon-examples/issues/147
Skip to content

/ node-addon-examples

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

Jump to bottom

Consider adding JSDoc-style comments to the examples #147

Open
jschlight opened this issue Jul 13, 2020 · 1 comment
Open

Consider adding JSDoc-style comments to the examples #147

jschlight opened this issue Jul 13, 2020 · 1 comment

Comments

@jschlight
Copy link
Contributor

@jschlight jschlight commented Jul 13, 2020

This issue on the node-addon-api repository raises the question of using JSDoc-style comments in C++ code implementing native addons:

nodejs/node-addon-api#758

In addition, @mhdawson has identified another potential benefit of adding JSDoc-style comments to the C++ code:

nodejs/node-addon-api#749 (comment)

Once the tutorial site lands, I'd like to do a review of the current content and at that time I can investigate the feasibility of adding JSDoc-style comments to our examples.
@mhdawson
Copy link
Member

@mhdawson mhdawson commented Jul 13, 2020

As discussed in the N-API team meeting today, sounds like a great idea.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@mhdawson @jschlight
You can’t perform that action at this time.