3 ms·
# In those situations a single line like "This context links the rendering pipeline to the physics simulation" would go a very long way. Why not rewrite your c
by erikpukinskis 14y ago
# In those situations a single line like "This context links the rendering pipeline to the physics simulation" would go a very long way.
Why not rewrite your code so there is a rendering_pipepline variable and a physics_simulation variable and a function called link? Then the comment is redundant.
That's what refactoring for self-documentedness is to me.
- goblin89 14y agoIndeed. Document the Whys, and let the code itself document the Whats.
- TikiTDO 14y agoWhile that is a perfectly reasonable solution to the minimal example I provided, there may be reasons to abstract away the concept. Personally, I like having some sort of structure in memory that allows me to access and query contextual information. It's amazingly useful if you are trying to link a variety of different elements. In fact it's practically unavoidable if you are writing highly dynamic code. Trying to manage this sort of system with a few variables and functions would become a nightmare. In fact, those dynamic situations are where comments describing layout are absolutely critical. In these situations you may be using your class as a generalization, and tracking the full extent of this sort of interaction could take a ridiculous amount of time.