Ok ok ok, so now that you guys have made me truly feel like a horrible person
on the inside, I have redone my ASM file and commented every bit of
commentable code, and then some. I hope it helps me when debugging this thing.

Quoting Olin Lathrop <olin_piclist@EMBEDINC.COM>:

> > Right on, Olin!
> >
> > Ideally, the comments should be written first, then the code filled in
> to
> > do what the comments say!
> >
> > ...
> >
> > Thus endeth today's sermon.
>
> And if the religious arguments don't persuade you, here's a practical one:
>
> One of our current projects is to help a customer get a particular circuit
> board into production.  This is an ISA bus board that lives inside a PC
> running an RTOS which controls a complicated high end mechanical measuring
> system that costs multiple 100s of K$.  The board contains some
> intrumentation analog electronics, 14 bit A/Ds, FIFOs, and other stuff.
> Everything on the board is controlled by an Altera Max 7000 CPLD.  Contact
> with the original designer has been lost, but the schematics and CPLD
> source code are available.
>
> Unfortunately, the original designer didn't write a theory of operation
> document and the CPLD source code is only sparesly commented.  The
> customer is seeing some problems but is having a hard time chasing them
> down because nobody understands how this board works.  We are getting paid
> thousands of dollars just to understand and document every little detail
> of the board's operation, and eventually advise the customer on how to fix
> the problems.  Right now I'm knee deep in the CPLD source code.  I've
> already taken the original 250 line file and expanded it to 650 lines just
> by documenting the inputs and outputs.  I've still got most of the
> internal variables and about half the logic equations left to go.
>
> The moral of the story is bad commenting and documentation costs serious
> money, and that cleaning up other people's bad documentation is
> profitable.
>
>
> *****************************************************************
> Embed Inc, embedded system specialists in Littleton Massachusetts
> (978) 742-9014, http://www.embedinc.com
>
> --
> http://www.piclist.com hint: To leave the PICList
> mailto:piclist-unsubscribe-request@mitvma.mit.edu
>




----------------------------------------
This mail sent through www.mywaterloo.ca

--
http://www.piclist.com hint: To leave the PICList
mailto:piclist-unsubscribe-request@mitvma.mit.edu