2 ms·
Thank you for your kind reply. I totally agree better doc is needed to tie the actual code to its intended functions and architecture. One problem I've had repe
by mimixco 6y ago
Thank you for your kind reply. I totally agree better doc is needed to tie the actual code to its intended functions and architecture. One problem I've had repeatedly with writing this kind of doc is that it immediately goes out of date as soon as you refactor -- which we do often! That kind of low-level doc isn't something you need every day, but when you are chasing an ugly bug, it can be awfully helpful to have some plain English explanation how two functions relate to each other, or how their arguments are used -- since this is the source of most bugs.
Right now, it's very difficult to get doc that fully aligns your architecture diagrams with the actual code, function names, parms, etc. To us, this is the Holy Grail and part of what we are trying to built at Mimix. Using our MSL language, we plan to bring some of these kind of reuse and code diagramming features to the wiki editing environment.