{#}  Replies are directed back to [EMAIL PROTECTED]
{#}  To reply to the author, write to [EMAIL PROTECTED]

On Wednesday, November 7, 2001, at 04:32 PM, Erik Smartt wrote:

> I've looked, but have been unable to find any documentation on the 
> structure of the Fire code.  This is not uncommon, but the reason I 
> bring this up is because the source code contains VERY few comments.  I 
> know that Objective-C is pretty easy to read-- BUT, what's missing is 
> the rational for why things are done the way they are.  As someone new 
> to the project (but highly interested) it's taking a lot of time 
> digging through the code to figure out how all these pieces are related 
> and how messages are passed.
>
> I understand all to well how easy it is to leave out comments when 
> coding because you fully grok what's going on... but since (many) other 
> people are now looking at the code, it would really help encourage 
> contributions if the code was better documented.

Yeah, this is a known bug with the developers.  ;)  You're not the first 
person to request this, and I've been trying to be better about 
commenting as I go.  I'm getting better, but still have a long way to go.

> Don't get me wrong, there's some amazing work going into this project, 
> and Fire is now one of my "must have" applications.  But it is a 
> particularly difficult one to get ramped up on because there are no 
> explanations in the code.  I've also come across a good number of 
> short-cuts in there, that really should have been explained.  Maybe 
> just as everyone goes forward, they could leave some notes in their 
> code to explain their logic to others -- it really will help the 
> project as a whole.
>
> Just my $0.02,
>   -- Erik
>
>
> {#} ----------------------------------------------------+[ fire ]+---
>
>
>
--
Colter Reed
AIM/MSN/Yahoo : Sanguerent  ICQ : 113022030


{#} ----------------------------------------------------+[ fire ]+---



Reply via email to