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

Remove comments in code snippets #3

Open
elfenpiff opened this issue Dec 17, 2021 · 4 comments
Open

Remove comments in code snippets #3

elfenpiff opened this issue Dec 17, 2021 · 4 comments

Comments

@elfenpiff
Copy link

Most of the time geoffrey is used to explain pieces of code in detail and then additional comments are like a double documentation. Here it would be helpful when geoffrey would ignore the code comments (maybe enabled via some option in the geoffrey markdown line) so that the reader of the markdown file could concentrate on the actual code example alone.

@elBoberido
Copy link
Collaborator

I also thought about that. I'm just not sure how to add customization options to the geoffrey tag. Maybe something like this

<!-- [geoffrey] [path/to/source/file] [doxygen snippet annotation] {strip-comments} -->

@elfenpiff
Copy link
Author

Yes this looks nice.

@elBoberido
Copy link
Collaborator

elBoberido commented Dec 20, 2021

On a second thought, comments are not that easy since you can also have multi line comments. How about something more generic like

<!-- [geoffrey] [path/to/source/file] [doxygen snippet annotation] {strip "^\s*//"} -->

@elfenpiff
Copy link
Author

I like the more generic approach even more!

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