Thanks, Javier.
Was just wondering .
I, too, pepper comments throughout. Below, a typical header. Sometimes I
spell out the logic in-full before the list of source, intermediate and
output tableView(s). This allows me to see - in this case, coming back
after seven years - what I did and how everything stitches together.
I've adopted this protocol because I came back to this set of code files
after seven years and could make neither heads nor tails of it.
Sample (Courier New font):
{water stats | 0310 | generate year and per-month views}
--file: wstat_0310_nMoDA_charting_daSeries_monthly.rmd
--rbse: eWaterMetrics
--auth: baChitiea
--crea: 2014-05-20
--updt: 2015-11-12
--updt: 2022-03-06
--updt: 2022-03-21
--updt: 2022-04-18
--updt: 2022-04-20
{Generate invidivual views of monthly nMoDA USAGE and COST data}
{for Charting Series: 03100x}
{source tableView(s):
global_calendarMonth_z +
wstat_022000_nMoStats_t}
{intermediate tableView(s):
wstat_031003_nMoDA_series_monthly_tvw
wstat_031004_nMoDA_series_monthly_tt}
{output tableView(s):
wstat_031001_calYear_tvw
wstat_031002_monthxx_tvw | xx = 01-12 | (dropped in 0330)
wstat_031000_nMoDA_series_monthly_t}
--file id
----------------------------------------------------------------------
LABEL start
SET VAR vcurrentFile TEXT = 'wstat_0310'
Bruce A. Chitiea | SafeSectors, Inc.
112 Harvard Ave #272 | Claremont CA 91711-4716 | USA
+011 (909) 238-9012 m | [email protected]
------ Original Message ------
From: [email protected]
To: [email protected]
Sent: 4/20/2022 11:36:34 AM
Subject: RE: [RBASE-L] - RMD File Comment Header Sections | Fastest
Processing
I have a header at the top that contains an overall description of the
process as well as the creation date and date of last modification with
details of the modifications.
I also have lots of single line comments at many places throughout the
code to indicate specific processes such as:
-- Begin life cycle cost calculations
-- Open external ODBC table
-- Call stored function XXX
…and such.
Also, I spell command names fully in upper case, no shortcuts used and
leave blank lines to separate blocks of code. Memory and storage are no
longer an issue like in the old DOS days, so I make it easy to read.
Basically, I want to make sure that anyone else looking at the code can
follow the logic and flow easily.
Javier,
Javier Valencia, PE
913-915-3137
From:[email protected] <[email protected]> On Behalf Of
Bruce Chitiea
Sent: Wednesday, April 20, 2022 9:24 AM
To:[email protected]
Subject: [RBASE-L] - RMD File Comment Header Sections | Fastest
Processing
All:
I've bit the documentation bullet while writing RMD files, inserting
extensive comments just below {filename comment} header.
Which processes the fastest?
- multiple comment paragraphs, sandwiched by {squiggly} brackets?
- individual comment lines, preceded by double-hyphens
- comments of either type sandwiched between a [ GOTO ... LABEL ] pair
I'm concerned that the parser might get bored reading about what it's
about to find out anyway.
Thanks much, Bruce
Bruce A. Chitiea | SafeSectors, Inc.
112 Harvard Ave #272 | Claremont CA 91711-4716 | USA
+011 (909) 238-9012 m | [email protected]
--
For group guidelines, visit
http://www.rbase.com/support/usersgroup_guidelines.php
---
You received this message because you are subscribed to the Google
Groups "RBASE-L" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/rbase-l/emaae1a1e9-5c72-4905-8fb4-0c3c96f1231f%40pathfinder
<https://groups.google.com/d/msgid/rbase-l/emaae1a1e9-5c72-4905-8fb4-0c3c96f1231f%40pathfinder?utm_medium=email&utm_source=footer>.
--
For group guidelines, visit
http://www.rbase.com/support/usersgroup_guidelines.php
---
You received this message because you are subscribed to the Google
Groups "RBASE-L" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/rbase-l/!%26!AAAAAAAAAAAYAAAAAAAAAG1gU%2BA71stIig71BAFnx9iihQAAEAAAAEDPIif5pXFPn6pVc1jroIYBAAAAAA%3D%3D%40vtgonline.com
<https://groups.google.com/d/msgid/rbase-l/!%26!AAAAAAAAAAAYAAAAAAAAAG1gU%2BA71stIig71BAFnx9iihQAAEAAAAEDPIif5pXFPn6pVc1jroIYBAAAAAA%3D%3D%40vtgonline.com?utm_medium=email&utm_source=footer>.
--
For group guidelines, visit
http://www.rbase.com/support/usersgroup_guidelines.php
---
You received this message because you are subscribed to the Google Groups "RBASE-L" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/rbase-l/em312c08b8-6d56-499a-aa0e-9cab9759911c%40pathfinder.
