I have mentioned in passing several times on this list that I was planning to change our style from the /* ... */ form of comments to the // form. To review my motivations for this change, it just seems a neater, simpler style to me without all the special leading asterisks that are required to make the multiline /* ... */ form safe to use. I have also recently proved that the // form is fine for our doxygen commentary. Furthermore, // is part of the c99 standard so it is unlikely any modern C compiler will have trouble with this form of comments, and indeed the small number of // form of comments that have been in our C code for a while have not seemed to cause any problems.
Previously there have only been two objections (one a concern about doxygen that turned out to be incorrect and one a concern about an old compiler that turned out to be incorrect) to the // style. So I assume there will be no strong objections to this style change. However, on the off-chance there are such strong objections, please let me know tomorrow (Friday) because, otherwise, I plan to make this wholesale change starting this weekend. The planned implementation will consist of an addition to the scripts/style_source.sh script to deal with comment style using the scripts/convert_comment.py python script to do the changes (in --diff or --apply mode) rather than uncrustify (which as far as I know has not implemented this style option yet). As with the rest of the style changes that can potentially be applied by scripts/style_source.sh, the --diff option gives you some safety (if you pay attention!) since it gives you a preview of exactly what is going to be changed for every file before you use the --apply option to actually make those changes. Alan __________________________ 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 (lbproject.sf.net). __________________________ Linux-powered Science __________________________ ------------------------------------------------------------------------------ Beautiful is writing same markup. Internet Explorer 9 supports standards for HTML5, CSS3, SVG 1.1, ECMAScript5, and DOM L2 & L3. Spend less time writing and rewriting code and more time creating great experiences on the web. Be a part of the beta today. http://p.sf.net/sfu/beautyoftheweb _______________________________________________ Plplot-devel mailing list Plplot-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/plplot-devel
