stepan-mitkin / drakon.tech

Drakon.Tech is an IDE based on the DRAKON visual language
The Unlicense
64 stars 15 forks source link

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

Open stepan-mitkin opened 4 years ago

stepan-mitkin commented 4 years ago

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.