Re: Is code self documenting?

2013-11-01 Thread Paul McNett
On 10/31/13 3:28 PM, Ed Leafe wrote: On Oct 31, 2013, at 4:45 PM, Dennis Schuette den...@cbsds.com wrote: One of the documenting features I use is something like: *By this time (corsorname) could be populated with ... * and (some process) should be done That way, when I look at something

RE: Is code self documenting?

2013-11-01 Thread Gene Wirchenko
At 18:12 2013-10-31, Ken Dibble krdib...@stny.rr.com wrote: And why is the START button in windows used to END the system? Same reason Init 0 shuts down Linux. init actually. Thank you for the reminder. I may be using your explanation in the future with malice aforethought.

Re: Is code self documenting?

2013-10-31 Thread Alan Bourke
On Wed, Oct 30, 2013, at 10:43 PM, Ted Roche wrote: On Wed, Oct 30, 2013 at 6:14 PM, Dan Covill dcov...@san.rr.com wrote: Article is Why You Shouldn't Comment (or Document) Code Up next, the Tabs versus Spaces controversy Next, Normalization Is Overrated... Hey, don't forget

Re: Is code self documenting?

2013-10-31 Thread Jeff Johnson
I comment my code. I've been working on some of the same code for over 20 years. Early on I commented the code where it is not clear what the code does. I also put comments in like, * this needs to be refactored Since I work on payroll for companies, when someone tells me to make a change

RE: Is code self documenting?

2013-10-31 Thread Virgil Bierschwale
at, and it will help you to get up to speed pretty fast. -Original Message- From: ProFox [mailto:profox-boun...@leafe.com] On Behalf Of Jeff Johnson Sent: Thursday, October 31, 2013 8:14 AM To: profox@leafe.com Subject: Re: Is code self documenting? I comment my code. I've been working on some

Re: Is code self documenting?

2013-10-31 Thread Man-wai Chang
[mailto:profox-boun...@leafe.com] On Behalf Of Jeff Johnson Sent: Thursday, October 31, 2013 8:14 AM To: profox@leafe.com Subject: Re: Is code self documenting? I comment my code. I've been working on some of the same code for over 20 years. Early on I commented the code where it is not clear what

RE: Is code self documenting?

2013-10-31 Thread Dave Crozier
I was always told in my early career to always document things that the readable (hopefully) code didn't tell you and to make the code legible i.e. comments like * Increment the counter nCounter=nCounter+1 are really superfluous if the variables are declared with sensible names and merely

RE: Is code self documenting?

2013-10-31 Thread Dave Crozier
but they can't say that they haven't been told. Dave -Original Message- From: ProFox [mailto:profox-boun...@leafe.com] On Behalf Of Dave Crozier Sent: 31 October 2013 13:32 To: ProFox Email List Subject: RE: Is code self documenting? I was always told in my early career to always document things

Re: Is code self documenting?

2013-10-31 Thread Kevin Cully
I have a client that flip-flops on features a lot. I'm able to say You had me create this in 2007, and then disable it in 2009, only to turn it back on a month later. Do you still want me to turn it off after it's been running this way for the last 4 years? For this type of client, the more

RE: Is code self documenting?

2013-10-31 Thread Allen
Maybe in this case there should be a software switch so the user can turn it on and off as they wish. Al -Original Message- I have a client that flip-flops on features a lot. I'm able to say You had me create this in 2007, and then disable it in 2009, only to turn it back on a month

RE: Is code self documenting?

2013-10-31 Thread Virgil Bierschwale
: RE: Is code self documenting? Maybe in this case there should be a software switch so the user can turn it on and off as they wish. Al -Original Message- I have a client that flip-flops on features a lot. I'm able to say You had me create this in 2007, and then disable it in 2009, only

Re: Is code self documenting?

2013-10-31 Thread Kevin Cully
It was more of a case that the client comprehend the complexity of his business, and was confusing himself with his own terminology. For just one example, he had a field for PPC or Pieces per carton. For one vendor he would mean it to be 100 pieces in the carton make up one product and for

RE: Is code self documenting?

2013-10-31 Thread John Harvey
Maybe that's what happened to Obamacare? -Original Message- From: ProFox [mailto:profox-boun...@leafe.com] On Behalf Of Ted Roche Sent: Wednesday, October 30, 2013 2:56 PM To: profox@leafe.com Subject: Re: Is code self documenting? On Wed, Oct 30, 2013 at 4:08 PM, Ed Leafe ed.le

Re: Is code self documenting?

2013-10-31 Thread Alan Bourke
On Thu, Oct 31, 2013, at 02:05 PM, Virgil Bierschwale wrote: Wonder how many systems are out there like that A lot. A lot a lot. ___ Post Messages to: ProFox@leafe.com Subscription Maintenance: http://mail.leafe.com/mailman/listinfo/profox

Re: Is code self documenting?

2013-10-31 Thread Stephen Russell
On Thu, Oct 31, 2013 at 8:14 AM, Jeff Johnson j...@san-dc.com wrote: I comment my code. I've been working on some of the same code for over 20 years. Early on I commented the code where it is not clear what the code does. I also put comments in like, * this needs to be refactored Since I

RE: Is code self documenting?

2013-10-31 Thread Dave Crozier
] On Behalf Of Alan Bourke Sent: 31 October 2013 15:18 To: profox@leafe.com Subject: Re: Is code self documenting? On Thu, Oct 31, 2013, at 02:05 PM, Virgil Bierschwale wrote: Wonder how many systems are out there like that A lot. A lot a lot. [excessive quoting removed by server

Re: Is code self documenting?

2013-10-31 Thread Ted Roche
On Thu, Oct 31, 2013 at 11:18 AM, Alan Bourke alanpbou...@fastmail.fmwrote: On Thu, Oct 31, 2013, at 02:05 PM, Virgil Bierschwale wrote: Wonder how many systems are out there like that A lot. A lot a lot. Most of them, in my experience. A business owner tends to talk about what they

Re: Is code self documenting?

2013-10-31 Thread Ted Roche
On Thu, Oct 31, 2013 at 4:32 AM, Alan Bourke alanpbou...@fastmail.fmwrote: Hey, don't forget the One True Brace Style! Yet another classic! Function foo(bar) { * code } or: Function foo(bar) { * code } or worse! SQL is another formatting nightmare. Whenever I'm using a helpful

Re: Is code self documenting?

2013-10-31 Thread MB Software Solutions, LLC
On 10/31/2013 11:20 AM, Dave Crozier wrote: Rule 1 of writing software for nontechnical users is this: if they have to read documentation to use it you designed it wrong. I can get behind this one -- Mike Babcock, MCP MB Software Solutions, LLC President, Chief Software Architect

Re: Is code self documenting?

2013-10-31 Thread Gene Wirchenko
At 08:33 2013-10-31, MB Software Solutions, LLC mbsoftwaresoluti...@mbsoftwaresolutions.com wrote: On 10/31/2013 11:20 AM, Dave Crozier wrote: Rule 1 of writing software for nontechnical users is this: if they have to read documentation to use it you designed it wrong. I can get behind this

Re: Is code self documenting?

2013-10-31 Thread Stephen Russell
On Thu, Oct 31, 2013 at 11:55 AM, Gene Wirchenko ge...@telus.net wrote: At 08:33 2013-10-31, MB Software Solutions, LLC mbsoftwaresolutions@**mbsoftwaresolutions.commbsoftwaresoluti...@mbsoftwaresolutions.com wrote: On 10/31/2013 11:20 AM, Dave Crozier wrote: Rule 1 of writing software

RE: Is code self documenting?

2013-10-31 Thread Dave Crozier
And why is the START button in windows used to END the system? ;-) Dave -Original Message- From: ProFox [mailto:profox-boun...@leafe.com] On Behalf Of Stephen Russell Sent: 31 October 2013 17:05 To: ProFox Email List Subject: Re: Is code self documenting? On Thu, Oct 31, 2013 at 11:55

Re: Is code self documenting?

2013-10-31 Thread Gene Wirchenko
At 10:04 2013-10-31, Stephen Russell srussell...@gmail.com wrote: On Thu, Oct 31, 2013 at 11:55 AM, Gene Wirchenko ge...@telus.net wrote: [snip] Please, no! This gets into inanities where something fairly simple is not documented and you have to find out about it by accident.

Re: Is code self documenting?

2013-10-31 Thread Stephen Russell
On Thu, Oct 31, 2013 at 12:47 PM, Gene Wirchenko ge...@telus.net wrote: On a related note, I got a business card recently where instead of labelling the phone numbers (four of them) with words like Office and Fax, icons were used. The icons were on the small side, and I think I figured

RE: Is code self documenting?

2013-10-31 Thread Gene Wirchenko
At 10:06 2013-10-31, Dave Crozier da...@flexipol.co.uk wrote: And why is the START button in windows used to END the system? ;-) Because you are starting the shutdown sequence. This whine about Windows has been going on for way too long. Similar constructions are used in spoken

Re: Is code self documenting?

2013-10-31 Thread Jeff Johnson
+1 Jeff --- Jeff Johnson j...@san-dc.com (623) 582-0323 www.san-dc.com www.arelationshipmanager.com On 10/31/2013 08:33 AM, MB Software Solutions, LLC wrote: On 10/31/2013 11:20 AM, Dave Crozier wrote: Rule 1 of writing software for nontechnical users is this: if they have to

RE: Is code self documenting?

2013-10-31 Thread Dennis Schuette
: ProfoxTech [mailto:profoxtech-boun...@leafe.com] On Behalf Of Jeff Johnson Sent: Thursday, October 31, 2013 6:14 AM To: profoxt...@leafe.com Subject: Re: Is code self documenting? I comment my code. I've been working on some of the same code for over 20 years. Early on I commented the code where

Re: Is code self documenting?

2013-10-31 Thread Ed Leafe
On Oct 31, 2013, at 4:45 PM, Dennis Schuette den...@cbsds.com wrote: One of the documenting features I use is something like: *By this time (corsorname) could be populated with ... * and (some process) should be done That way, when I look at something months later, I know what to expect

RE: Is code self documenting?

2013-10-31 Thread Ken Dibble
And why is the START button in windows used to END the system? Same reason Init 0 shuts down Linux. Ken Dibble www.stic-cil.org ___ Post Messages to: ProFox@leafe.com Subscription Maintenance: http://mail.leafe.com/mailman/listinfo/profox OT-free

Re: Is code self documenting?

2013-10-30 Thread Ed Leafe
On Oct 30, 2013, at 2:47 PM, Stephen Russell srussell...@gmail.com wrote: http://visualstudiomagazine.com/articles/2013/06/01/roc-rocks.aspx Article is Why You Shouldn't Comment (or Document) Code Geez, I keep seeing this same tired argument, especially from the Ruby crowd. Yes, stupid

Re: Is code self documenting?

2013-10-30 Thread Ted Roche
On Wed, Oct 30, 2013 at 4:08 PM, Ed Leafe ed.le...@rackspace.com wrote: On Oct 30, 2013, at 2:47 PM, Stephen Russell srussell...@gmail.com wrote: http://visualstudiomagazine.com/articles/2013/06/01/roc-rocks.aspx Article is Why You Shouldn't Comment (or Document) Code Geez, I keep

Re: Is code self documenting?

2013-10-30 Thread Stephen Russell
On Wed, Oct 30, 2013 at 3:56 PM, Ted Roche tedro...@gmail.com wrote: On Wed, Oct 30, 2013 at 4:08 PM, Ed Leafe ed.le...@rackspace.com wrote: On Oct 30, 2013, at 2:47 PM, Stephen Russell srussell...@gmail.com wrote: http://visualstudiomagazine.com/articles/2013/06/01/roc-rocks.aspx

Re: Is code self documenting?

2013-10-30 Thread Paul McNett
On 10/30/13 2:08 PM, Stephen Russell wrote: /* State what change they want now. It may have already been done and is just commented out below SCR 2/13/2012 Add another parameter to pass to the sproc. */ IMO these belong in the commit message in git. Nobody cares that the parameter

Re: Is code self documenting?

2013-10-30 Thread Stephen Russell
On Wed, Oct 30, 2013 at 4:14 PM, Paul McNett p...@ulmcnett.com wrote: On 10/30/13 2:08 PM, Stephen Russell wrote: /* State what change they want now. It may have already been done and is just commented out below SCR 2/13/2012 Add another parameter to pass to the sproc. */ IMO

Re: Is code self documenting?

2013-10-30 Thread Dan Covill
On 10/30/13 12:47 PM, Stephen Russell wrote: http://visualstudiomagazine.com/articles/2013/06/01/roc-rocks.aspx Article is Why You Shouldn't Comment (or Document) Code Presumably written by the same folks who decided that the Windows 8 Start Screen didn't need any tooltips, since it was so

Re: Is code self documenting?

2013-10-30 Thread Ted Roche
On Wed, Oct 30, 2013 at 6:14 PM, Dan Covill dcov...@san.rr.com wrote: Article is Why You Shouldn't Comment (or Document) Code Up next, the Tabs versus Spaces controversy Next, Normalization Is Overrated... It's almost as predictable as tabloid seasonal headlines... -- Ted Roche Ted Roche