[Bf-committers] Summer of Documentation

[trip somewhere]

That said ton, if no attempt to comment in the code happens again we
will have a code base that is still very hard to read for another
year.

I understand why you think it would be messy. but unless I miss
something comments can just be ignorred.

Just having something to read from as a starting point each time I
start digging in would be a blessing. And then when someone does get
it then maybe they can make one of those diagrams for derivedmesh for
ya..

I'm not asing for something like the Doxy system, I just need some
more comments instead of archaic answers like this
// editmesh.h shouldn't be in this file... ok for now?
OR
/* according manpages needed */

In reading books and stuff they ALL teach and drill it into your head
to comment your code be it whatever.. Not just give it titles of a one
line comment but as you go in it to comment what a said loop is
doing..

This sounds and makes sence to you now that you have been in the code
for a while but punks like me can't get it yet.. And most won't ..
Espiccially when we really don;t have much time to hop in and start
deciphering.

It's a small thing to ask but a HUGE time saver for new peeps.




On 5/14/06, Ton Roosendaal <ton at blender.org> wrote:
> Hi,
>
> I've got a bad experience with people adding comments in code, when
> they're not having the big picture. Comments should give insight in the
> structure of code or in the underlying thought process, and not
> explaining in words what code already tells itself.
>
> Docs like I tried to make for the render pipeline or Blender
> architecture, yes these should be done much more. I still would love to
> see a diagram how derivedmesh works! :)
>
> -Ton-
>
>
> On 14 May, 2006, at 18:05, trip somewhere wrote:
>
> > Well yeah when I get at least able to understanding the deeper basics
> > of it all in cvs i will ask.
> > But having more detailed comments already in the code would avoid a
> > great deal of these kind of questions in the mailing list from others
> > starting out as well.
> >
> >
> >
> >
> > On 5/14/06, Alexander Ewering <blender at instinctive.de> wrote:
> >>
> >> On Sun, 14 May 2006, trip somewhere wrote:
> >>
> >> > Would Summer of Documentation include comments in the cvs code as
> >> well
> >> > ? cause it sure could use some more.
> >>
> >> What parts of the code do you have problems with? Mailing specific
> >> questions
> >> to the list will help.
> >>
> >> | alexander ewering              instinctive mediaworks
> >> | ae[@]instinctive[.]de   http://www[.]instinctive[.]de
> >> _______________________________________________
> >> Bf-committers mailing list
> >> Bf-committers at projects.blender.org
> >> http://projects.blender.org/mailman/listinfo/bf-committers
> >>
> > _______________________________________________
> > Bf-committers mailing list
> > Bf-committers at projects.blender.org
> > http://projects.blender.org/mailman/listinfo/bf-committers
> >
> >
> >
> >
> ------------------------------------------------------------------------
> --
> Ton Roosendaal  Blender Foundation ton at blender.org
> http://www.blender.org
>
> _______________________________________________
> Bf-committers mailing list
> Bf-committers at projects.blender.org
> http://projects.blender.org/mailman/listinfo/bf-committers
>