4 ms·
I opened the comments with an intention to write basically the same thing. Higher level documentation - classes, packages, groups of packages - makes the proje
by RivieraKid 13y ago
I opened the comments with an intention to write basically the same thing.
Higher level documentation - classes, packages, groups of packages - makes the project much more approachable. It answers the question "Here's a 3 levels deep hierarchy - where do I start, how are the pieces connected to each other?"
Documenting classes is fairly common, but only the public API. I'm not only interested in how to use the class, but also how does it work internally, what is the inner architecture.
- arbutus 13y agoSame. Often I find myself wishing that I could see things as a sequence diagram. I've never worked anywhere where functions were commented with useless English descriptions of the parameters and so on, so I don't really know if this is something that people really do. What I do wish I had was more high-level, visual representations of a system when I'm trying to learn how it functions.