I wonder how do you document your Servoy Solutions and developments? After many years working with Servoy, we still have problems finding where did we use certain method, component or solution. We ended with multiple folders for different Servoy versions and more and more workspaces, so it is difficult to find something when we look for example on how to use a particular component or a sample on how to solve a particular problem.
What do you use in terms of documentation for that? In particular, do you use something to document what solutions are in each workspace and some documentation on what they do?
I completely get what you are asking here & where you are coming from
I wish I did document my solutions better, but I think the only thing I can say I try to do is comment as much as possible and fill out the JSDoc as much as I can, so when I come back to something, I can remind myself of what I was doing
I would like to know if someone has any kind of app (maybe done in Servoy), where you can document a Solution in terms of what it does, in what workspace is located and that kind of stuff.
I would like to have that kind of tool inside Eclipse in Servoy and i.e. search for “google chart” and see what solutions we already have that have that tag in order to take it as a sample or use it as a module.
sounds to me that you want modules like Servoy releases the ‘svyModules’
This could be a specific module for a single or (related) group of component or a more generic module full of ‘utils’ functions.
Once you have that, store it on your own GIT repository and add it to every project you need this for.
Apart from that you can add ‘code templates’ to eclipse which are very easy to extend.
Go to eclipse preferences and type ‘templates’ in the search bar.
Now choose the one in path ‘JavaScript > Editor > Templates’
As you can see there are a couple of templates that should look quite familiar to you.
This might not exactly be what you are asking for but…
I’m using docfetcher (a fulltext indexer) to do a quick search over multiple directories with sourcecode/workspaces/documentation/… - searching is pretty fast and doesn’t need any previous efforts for creating documentation.
I always hated using UML but now I’m using PlantUML to visualize aspects which are more structural. https://plantuml.com
It generates all kinds of diagrams from plain text which can be embedded inside code files optionally (but makes it easier to keep documentation and code in synch
There’s an Eclipse Plugin which can show the Diagrams inside Servoy Developer. This is nice and simple to visualize complicated logic or something like “what was overall changed and where to implement feature X?”
Generating an inheritance tree took me aprox 100 lines of servoy code.
PlantUML ir really good in visualizing dependencies. So if you grab the names of modules used in each solution and aggregate this you’ll eventually get a surprising graph.
Someone uses some tool to keep an index on the Servoy Solutions they have? Something like a Jukebox with a Title, Workspace, a description and things like that?