[Bf-committers] Summer of Documentation
Ton Roosendaal
ton at blender.org
Sun May 14 18:11:35 CEST 2006
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
More information about the Bf-committers
mailing list