2 ms·
> So, is it a good idea to try documenting the code design through some sort of visualization? Yes, if it helps you understand how it works and how the pieces
by KronisLV 4y ago
> So, is it a good idea to try documenting the code design through some sort of visualization?
Yes, if it helps you understand how it works and how the pieces fit together.
No, if the previous is not all that useful for you (different types of learners), or you need to spend significant amounts of time doing it manually, especially given that code could change.
If you can, look into any tool that might allow you to get visualizations in an automated manner.
For example, JetBrains IDEs have a few different graph visualizations for dependencies and inheritance etc.: https://www.jetbrains.com/help/idea/2022.1/tests-in-ide.html?q=graph&s=full https://www.jetbrains.com/help/idea/2022.1/tests-in-ide.html...
There also used to be SourceTrail, though sadly the project is now retired: https://github.com/CoatiSoftware/Sourcetrail https://github.com/CoatiSoftware/Sourcetrail
For databases, you can also use external tools like DbVis: https://www.dbvis.com/features/ https://www.dbvis.com/features/
There are also a few tools here and there for visualizing networks or how container deployments look, but those are pretty situational/specific for each platform/setup.