Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Distinguish doc-comments from other comments
See original GitHub issuehttps://github.com/airbnb/javascript#comments--multiline
recommend /** ... */ without even mentioning /* ... */. The former should only be used for doc-comments. The latter should be used for all comments that are not doc-comments, even if they are multiline.
Issue Analytics
- State:
- Created 6 years ago
- Reactions:1
- Comments:11 (2 by maintainers)
Top Results From Across the Web
Differences between Doc comments and Comments in Dart
Doc Comments (///). Doc comment is for documentation purpose. The dartdoc parses doc comments and creates documentation pages.
Read more >How to Write Doc Comments for the Javadoc Tool - Oracle
The intent here is to distinguish the general method from any of its particular forms. Include the word "method" to distinguish it as...
Read more >Telling the difference between "comments" and "changes"
In Word 2013, when using Track Changes, I am having a very hard time distinguishing between "comments" and "changes.
Read more >Go Doc Comments - The Go Programming Language
“Doc comments” are comments that appear immediately before top-level package, const, func, type, and var declarations with no intervening newlines.
Read more >Documentation - Rust By Example
Doc comments are very useful for big projects that require documentation. When running rustdoc , these are the comments that get compiled into...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
aligns the
*s without beginning with a/**.Why does your example comment begin with “/**” rather than “/*”?