Hello!
Quick, subtle improvement that could benefit Workshop developers. It can be difficult to remember what each variable is for within the application. Can we be given the option to provide a description on each variable?
3 Likes
Hi, this sounds like a great usability improvement - are there specific types of variables you find most confusing? I can imagine a string of variable transformations could be tough to parse, although you are able to name each step in the transform list. Or is it the sheer quantity of variables that might be similar to each other? Curious to hear more about your use case - regardless we are tracking this feature internally.
I find this request interesting also and I would like to share my experience.
In my workshops I create statics variables used to reset other variables after an event like button click event. For instance boolean variables named alwas_true and always_false used in order to hide or display some widgets. Or static string variables used to select tabs after a button clic event.
These is not always easy to reflex de purpose of such variables in the name. And I made my own best practice naming rules and I try to be consistent over all my workshops. But maybe other developer will not understand.
And if I’m thinking about long-term maintenance by other people, I would like to explain in a short description the purpose of these variables.
1 Like
Yeah it’s the sheer quantity, I have done the same of creating my own naming best practices but sometimes you just need a sentence or two to describe what the variable is used for.
1 Like
Definitively useful. in workshop we are creating many variables and having a description would really help
To some extend, this would mimic the comments in actual program code.
The main form of organizing variables in code is to group your code into modules. While we have different pages and sections for widgets, variables cannot be grouped in a similar fashion. I can imagine that it would also be really helpful to manually group these variables which also gives a better overview without having to read all single comments.
This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.