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

Add the diagram url before the generated code for each function #11

Open
stepan-mitkin opened this issue Apr 5, 2020 · 0 comments
Open
Labels
generator Code generator

Comments

@stepan-mitkin
Copy link
Owner

Today I was doing a code review. One of our programmers implemented a new feature, but did not realise he was editing a generated javascript file.

So the changes are now in javascript code and not in the drakon diagrams.

We added a readme in the project, pointing to de drakon tech site, but he did not see at that. He searched through the code to see where he had to make changes, so he also never saw the header.

Would it be possible to add comments to the generated code before each function? The comment could even include a drakon.tech url..

// Created with drakon tech. Diagram url: https://app.drakon.tech/ide/doc/channelme/59
function handleChatMessage(model, topic, message) {

}

That way he probably would have realized it was generated code, and could immediately jump into the diagram.

@stepan-mitkin stepan-mitkin added the generator Code generator label Apr 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
generator Code generator
Projects
None yet
Development

No branches or pull requests

1 participant