Revision 11301 completed the Java comments styling upgrade. No
further comment style upgrades are planned so this combined with the
previous C and C++ work (finally) completes the project. It was a lot
of effort, but I am quite pleased with the results.
I assume most of you have felt constrained about doing PLplot
development during such a large set of changes. I encourage you to
get back to work on PLplot now that this commit storm is over. :-)
With regard to comment style for our C, C++, and Java code, the best
thing to do from now on is to always use the // form except for the
embedded comment case (i.e., where parts of the line are commented out
by /* ... */ fragments that don't comment all the way to the end of
With regard to the continued // comments (i.e., a // comment line that
ends with backslash), I recommend you avoid those if possible.
scripts/convert_comment.py (which is called by
scripts/style_source.sh) has no trouble with those (so long as the
next line is also a comment line marked by //), but there is an
with regard to such continued comments that needs to be worked around
as in bindings/tcl/tclAPI.c.
As a result of eyeballing all the changes that
scripts/convert_comment.py has produced up to now, I feel that script
is pretty robust and also produces nicely formatted (e.g., properly
indented) //-style comment results. However, if you find some style
issue (indentation or otherwise) with the comments now, please correct
the problem by hand unless it is a systematic problem that can be
dealt with by a change to scripts/convert_comment.py.
If you do forget and use the old-style /* ... */ form for comments for
C, C++, or Java, then the next time somebody runs
scripts/style_source.sh, that issue should be corrected by the
scripts/convert_comment.py script that is run by
scripts/style_source.sh. Of course, I encourage those with access to
bash and python to run scripts/style_source.sh _before_ they commit
their changes. Run "scripts/style_source.sh --help" to learn how to
run that script including options that allow you to preview the style
Alan W. Irwin
Astronomical research affiliation with Department of Physics and Astronomy,
University of Victoria (astrowww.phys.uvic.ca).
Programming affiliations with the FreeEOS equation-of-state implementation
for stellar interiors (freeeos.sf.net); PLplot scientific plotting software
package (plplot.org); the libLASi project (unifont.org/lasi); the Loads of
Linux Links project (loll.sf.net); and the Linux Brochure Project