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

[Feature Request] Add support for c-style comments for documentation #103

Open
martinbudden opened this issue Nov 22, 2020 · 2 comments
Open

Comments

@martinbudden
Copy link
Contributor

That is allow /*! ... */ comments, so

/*!
blurb
blurb
blurb
*/

could be used as well as

//!blurb
//!blurb
//!blurb

This would make editing documentation much easier.

@nophead
Copy link
Owner

nophead commented Nov 27, 2020

Problem is the simple parsing code is structured around processing one line at a time. It would need to maintain state between lines and get more complicated.

@martinbudden
Copy link
Contributor Author

Agreed it would be slightly more complicated. But the state is a simple one - either you are in a comment or you are not. It would be perfectly fine to force a quite if the user started to nest comments or anything vaguely complicated.

I think it's worth it - this would really make a difference when writing assembly instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants