Collaborative software projects benefit when participants read code created by other participants. The objective of a coding style is to reduce the fatigue induced by unimportant formatting differences and differences in naming conventions. Although individual programmers will undoubtedly have preferences and habits that differ from the recommendations here, the benefits that flow from following these recommendations far outweigh the inconveniences. Published papers in journals are subject to similar stylistic and layout constraints, so such constraints are not new to the academic community. This document describes the coding style used in Ptolemy II, a package with 550K lines of Java and 160 contributing programmers that has been under development since 1996.
The Ptolemy Coding Style document is available in PDF format locally or via the UC Berkeley EECS Department Technical Report web site.
C. Brooks and E. A. Lee, "Ptolemy Coding Style," EECS Department, University of California, Berkeley, Tech. Rep. UCB/EECS-2014-164, Sep. 2014.
@techreport{Brooks:EECS-2014-164,
Author = {Brooks, Christopher and Lee, Edward A.},
Title = {Ptolemy Coding Style},
Institution = {EECS Department, University of California, Berkeley},
Year = {2014},
Month = {Sep},
URL = {http://www.eecs.berkeley.edu/Pubs/TechRpts/2014/EECS-2014-164.html},
Number = {UCB/EECS-2014-164},
Abstract = {Collaborative software projects benefit when participants read code created by other participants. The objective of a coding style is to reduce the fatigue induced by unimportant formatting differences and differences in naming conventions. Although individual programmers will undoubtedly have preferences and habits that differ from the recommendations here, the benefits that flow from following these recommendations far outweigh the inconveniences. Published papers in journals are subject to similar stylistic and layout constraints, so such constraints are not new to the academic community. This document describes the coding style used in Ptolemy II, a package with 550K lines of Java and 160 contributing programmers that has been under development since 1996.}
}
%0 Report
%A Brooks, Christopher
%A Lee, Edward A.
%T Ptolemy Coding Style
%I EECS Department, University of California, Berkeley
%D 2014
%8 September 5
%@ UCB/EECS-2014-164
%U http://www.eecs.berkeley.edu/Pubs/TechRpts/2014/EECS-2014-164.html
%F Brooks:EECS-2014-164