Skip to content

Discriminate doc comments from single line comments #88

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.

Sign up for GitHub

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
Closed
Luni-4 opened this issue Jul 22, 2020 · 5 comments · Fixed by #99
Closed

Discriminate doc comments from single line comments #88

Luni-4 opened this issue Jul 22, 2020 · 5 comments · Fixed by #99

Comments

@Luni-4
Copy link
Contributor

Luni-4 commented Jul 22, 2020

It would be helpful to discriminate doc comments (///) from single line comments (//). Currently, they are assigned to the same token
@Luni-4 Luni-4 changed the title Discriminate doc syntax from single line comments Discriminate doc comments from single line comments Jul 22, 2020
@resolritter resolritter mentioned this issue Jan 7, 2021
Merged
@aryx
Copy link
Contributor

aryx commented Jan 5, 2022

Just curious, what is your use case? why do you need to discriminate them?

@bestouff
Copy link

bestouff commented Jan 5, 2022

I find it more ergonomic to see at a glance where doc comments are, and which parts of code have (or have no) doc comments.

@Luni-4
Copy link
Contributor Author

Luni-4 commented Jan 5, 2022

Just curious, what is your use case? why do you need to discriminate them?

It would be helpful to compute metrics that determine how much a code is documented in percentage

@koalp
Copy link

koalp commented Jan 5, 2022 •
edited
Loading

Just curious, what is your use case? why do you need to discriminate them?

Another usecase mentioned in #99 (comment) is to highlight doc comments as they are markdown. It would be especially useful for long documentation, like in modules.

@aryx aryx closed this as completed in #99 Jan 10, 2022
@maddiemort
Copy link

Should this be reopened? It looks like the changes from #99 were immediately reverted.

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
Development

Successfully merging a pull request may close this issue.

Designate doc comments resolritter/tree-sitter-rust
5 participants
@aryx @bestouff @Luni-4 @maddiemort @koalp