Re: Source Code Documentation

2007-01-27 Thread Denny Valliant
On 1/27/07, Paul Ihrig <[EMAIL PROTECTED]> wrote: > i always try to get a paragraph of "call of cthulhu" into each page. > just html comment so you can read the whole book if you look at source code. > > used to coment in Job. > but that got a lttle depressing after a while That whole "written lan

Re: Source Code Documentation

2007-01-27 Thread Paul Ihrig
i always try to get a paragraph of "call of cthulhu" into each page. just html comment so you can read the whole book if you look at source code. used to coment in Job. but that got a lttle depressing after a while ~| Upgrade to

RE: Source Code Documentation

2007-01-27 Thread Jim Davis
> -Original Message- > From: Mike Tangorre [mailto:[EMAIL PROTECTED] > Sent: Friday, January 26, 2007 12:47 PM > To: CF-Community > Subject: Source Code Documentation > > Ok, how many of you adequately document your source code? By adequately I > mean to a point where another developer can

RE: Source Code Documentation

2007-01-26 Thread Mike Tangorre
> From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > nor do I have time to check my posts for spelling and typos > yeesh LOL, who sed anetheng aboute thet? ~| Upgrade to Adobe ColdFusion MX7 Experience Flex 2 & MX7 int

Re: Source Code Documentation

2007-01-26 Thread Cameron Childress
My source comments usually vary depending on the objects I am working with DAO and Beans are pretty much self explanatory to developers familiar with Patterns and OOP. Occasionally with those I'll include a short doc on what my definition of "Bean" and "DAO" are for the project and what they

Re: Source Code Documentation

2007-01-26 Thread Scott_A . _Stewart
art/REAC/HHQ/HUD) Subject: Re: Source Code Documentation Same here. I usually comment much like that Yves On 1/26/07, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote: > > i try to at least get the this does this and this does this. i usually > don't have tim e

Re: Source Code Documentation

2007-01-26 Thread Yves Arsenault
Same here. I usually comment much like that Yves On 1/26/07, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote: > > i try to at least get the this does this and this does this. i usually > don't have tim eto really document thhings like they should be. > > Scott A. Stewart > REAC/PASS-IT > (202)-

Re: Source Code Documentation

2007-01-26 Thread Scott_A . _Stewart
i try to at least get the this does this and this does this. i usually don't have tim eto really document thhings like they should be. Scott A. Stewart REAC/PASS-IT (202)-475-8875 "Mike Tangorre" <[EMAIL PROTECTED]> 01/26/2007 12:46 PM Please respond to cf-community To: CF-Comm

Re: Source Code Documentation

2007-01-26 Thread Yves Arsenault
Jackpot. On 1/26/07, Mike Tangorre <[EMAIL PROTECTED]> wrote: > > > From: William Bowen [mailto:[EMAIL PROTECTED] > > sigh... sometimes it sucks being a one man shop... > > bingo, +1. :-) > > > > > > > ~| Upgrade to Adobe Cold

Re: Source Code Documentation

2007-01-26 Thread William Bowen
> But I grew up programming for defense contractors, so if the docs don't take > 6 months, you are doing it wrong. I worked for a defense contractor once, the documentation we wrote kept coming back with markup like, "Strike this paragraph. There are _no_ subroutines for nuclear strikes in the gam

RE: Source Code Documentation

2007-01-26 Thread Mike Tangorre
> From: William Bowen [mailto:[EMAIL PROTECTED] > sigh... sometimes it sucks being a one man shop... bingo, +1. :-) ~| Upgrade to Adobe ColdFusion MX7 Experience Flex 2 & MX7 integration & create powerful cross-platform RIA

Re: Source Code Documentation

2007-01-26 Thread William Bowen
> Ok, how many of you adequately document your source code? I always start a project with adequate documentation in mind. > By adequately I > mean to a point where another developer can jump into an application and be > productive in a short period of time. That is the intention to be sure. > A

Re: Source Code Documentation

2007-01-26 Thread Jerry Johnson
Would love to document more, but your second statement forecludes it. And right after documentation, qa testing, and right after that, proper planning. But I grew up programming for defense contractors, so if the docs don't take 6 months, you are doing it wrong. =) On 1/26/07, Mike Tangorre <[E