Selected comments:

Yes, I now almost always document my initialization section like that.  I've
started doing it even for some variables that don't require initialization.
Like this:

  /* Initialization. */
  aids=''   /* aids:=list of ACIDs */
  op.=''    /* op.<chan>.<n>:=an output line for this channel */
  fx.=0     /* fx.<ACID>:=ACID was found in the dataset */
  nop.=0    /* nop.<chan>:=line counter for this output channel */
  pfls.=''  /* pfls.<ACID>:=profiles held by this ACID

Yes, I now assume that any wheel I have to invent is likely to be needed, in
some form or other, either later or more probably sooner.  I used to have a
boss who said "Bob, I need you to do such-and-such a task, but I know you:
Don't write a program for it, just do it.  It's just this one time."  I used
to feel obligated to obey.  But I've long since adopted a different
response:  "Sorry, I won't delegate that decision.  You tell me what you
want to accomplish; I'll decide whether a program or a manual effort will
get it for you faster and/or with fewer errors".  I tailor the wording for
the manager, of course; some I just say that, for others I have to soften
it, but I don't have to feel apologetic about it any longer.

Documentation first, eh?  I've started doing that, but a) I've barely
started and barely noticed that I was doing it, and b) I thought I was being
overly picky.  Now that you've called my attention to it, maybe I'll be more
conscious about it.

---
Bob Bridges, [email protected], cell 336 382-7313

/* The nice thing about being a celebrity is that if you bore people they
think it's their fault.  -Henry Kissinger */

-----Original Message-----
From: IBM Mainframe Discussion List <[email protected]> On Behalf Of
Seymour J Metz
Sent: Wednesday, June 16, 2021 04:24

I didn't comment adequately in my early years. Within a few year I routinely
had comments up front describing, e.g., the meaning of each parameter.

I used to write throw-away tools in the sure and certain knowledge that I
would only use them once. These days I am a lot less confident about
predicting that I'll never have to update them.

I developed the habit of writing documentation first, and changing the
documentation before changing the code. It has served me well.

----------------------------------------------------------------------
For IBM-MAIN subscribe / signoff / archive access instructions,
send email to [email protected] with the message: INFO IBM-MAIN

Reply via email to