Overdocumentation

Discussion about everything. New games, 3d math, development tips...
Post Reply
einsteinsci
Posts: 10
Joined: Tue Nov 19, 2013 3:35 am

Overdocumentation

Post by einsteinsci »

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:

Image
hendu
Posts: 2600
Joined: Sat Dec 18, 2010 12:53 pm

Re: Overdocumentation

Post by hendu »

You deserve it for using VS :P
CuteAlien
Admin
Posts: 9734
Joined: Mon Mar 06, 2006 2:25 pm
Location: Tübingen, Germany
Contact:

Re: Overdocumentation

Post by CuteAlien »

OK, that's a little crazy :-) I don't have 2013 installed so far (not even using 2012 yet which is installed) so I can't test right now. Maybe there is some way to configure it? I mean Irrlicht can't be the only library out there using big comment blocks...
IRC: #irrlicht on irc.libera.chat
Code snippet repository: https://github.com/mzeilfelder/irr-playground-micha
Free racer made with Irrlicht: http://www.irrgheist.com/hcraftsource.htm
thanhle
Posts: 325
Joined: Wed Jun 12, 2013 8:09 am

Re: Overdocumentation

Post by thanhle »

I actually like the detail on the document. You don't want to guess what the argument parameter do.

I actually want more :).
It would be great to also have a code snippet example associated with a function call :).
Post Reply