Overdocumentation
Posted: Sat Dec 14, 2013 10:12 pm
This isn't really all that off-topic, but I think this is the best place to post this. Please move the thread if I'm wrong.
Something that I found both helpful and unhelpful, and at the same time amusing, is that Irrlicht's functions can be given too much documentation. That is really helpful on how to use a function, but VS2013's intellisense decides to display it ALL AT ONCE, in a single tooltip. I'm still going through the tutorials, and I keep having to scroll through the code so the tooltip is out of the way so that I can see the other documentation. It gets really funny when you use a function like createCollisionResponseAnimator() and have a single tooltip covering half the screen like this:
Something that I found both helpful and unhelpful, and at the same time amusing, is that Irrlicht's functions can be given too much documentation. That is really helpful on how to use a function, but VS2013's intellisense decides to display it ALL AT ONCE, in a single tooltip. I'm still going through the tutorials, and I keep having to scroll through the code so the tooltip is out of the way so that I can see the other documentation. It gets really funny when you use a function like createCollisionResponseAnimator() and have a single tooltip covering half the screen like this:
.