> Date: Sun, 06 Jan 2002 11:11:52 -0800 (PST)
> From: "Sean 'Shaleh' Perry" <[EMAIL PROTECTED]>
> To: "Jamin W. Collins" <[EMAIL PROTECTED]>
> Subject: Re: Code Commenting
> Cc: [EMAIL PROTECTED]
>
> On 06-Jan-2002 Jamin W. Collins wrote:
> > How do you folks feel about someone commenting the BB code?
> >
> > I'm thinking of rather heavy descriptive commenting for every section,
> > to help explain what's being done in each area. Partially for my own
> > understanding but also for future maintenance. I know this somewhat
> > goes hand in hand with the previous list request for a "Blackbox
> > Walkthrough" and most of it could probably be lifted right from the
> > level of comments I'm thinking about. However, I'd like to see the
> > comments in the code.
> >
> > Jamin W. Collins
>
> xOr has done this a bit for the Window.{cc,hh} files. I agree there should be
> more comments. Howevever the code will changing a good deal so anyone who
> spends time now adding proper comments will just see their time wasted.
Well, the code should have been commented right when it was written,
and this should be valid for any new code, even that which isn't
expected to last for very long, since what is written as a temporary
hack to "fix" a bug before it get's fixed correctly may last for
months, or longer.
--
FreeBSD 4.4-STABLE
8:26PM up 11 days, 7:04, 16 users, load averages: 0.10, 0.09, 0.08
