{#} Replies are directed back to [EMAIL PROTECTED]
{#} To reply to the author, write to Eric Peyton <[EMAIL PROTECTED]>
On Wednesday, November 7, 2001, at 05:32 PM, Erik Smartt wrote:
> {#} Replies are directed back to [EMAIL PROTECTED]
> {#} To reply to the author, write to Erik Smartt
> <[EMAIL PROTECTED]>
>
>
> 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.
Hell - even I go through that and I wrote 95% of it. :-)
>
> 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. Things to remember. Fire was written for me and by me. I never
intended it for other users. It got the features I wanted it to have.
Most of the coding was done very late at night, with a few drinks behind
it :-) and it shows. (And a lot of it was done in 2 or 3 minutes while
something that pays the bills was compiling in the background). As
such, I never put any faith in comments - the code was never intended to
see the light of day and I (wrongfully assumed) that once
Openstep/Rhapsody/Mac OS X finally took off I would put the whole
project to rest. Boy was I wrong. :-)
> 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.
I will definitely try to "clean it up" as I go. The whole thing needs
some minor and major overhauls as it is ...
Eric
>
> Just my $0.02,
> -- Erik
>
>
> {#} ----------------------------------------------------+[ fire ]+---
>
>
{#} ----------------------------------------------------+[ fire ]+---
