*banner
 

Ptolemy Coding Style
Christopher Brooks, Edward A. Lee

Citation
Christopher Brooks, Edward A. Lee. "Ptolemy Coding Style". Technical report, University of California, Berkeley, UCB/EECS-2014-164, 2014.

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.

Electronic downloads

Citation formats  
  • HTML
    Christopher Brooks, Edward A. Lee. <a
    href="http://chess.eecs.berkeley.edu/pubs/1074.html"
    ><i>Ptolemy Coding Style</i></a>,
    Technical report,  University of California, Berkeley,
    UCB/EECS-2014-164, 2014.
  • Plain text
    Christopher Brooks, Edward A. Lee. "Ptolemy Coding
    Style". Technical report,  University of California,
    Berkeley, UCB/EECS-2014-164, 2014.
  • BibTeX
    @techreport{BrooksLee14_PtolemyCodingStyle,
        author = {Christopher Brooks and Edward A. Lee},
        title = {Ptolemy Coding Style},
        institution = {University of California, Berkeley},
        number = {UCB/EECS-2014-164},
        year = {2014},
        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.},
        URL = {http://chess.eecs.berkeley.edu/pubs/1074.html}
    }
    

Posted by Mary Stewart on 8 Sep 2014.
For additional information, see the Publications FAQ or contact webmaster at chess eecs berkeley edu.

Notice: This material is presented to ensure timely dissemination of scholarly and technical work. Copyright and all rights therein are retained by authors or by other copyright holders. All persons copying this information are expected to adhere to the terms and constraints invoked by each author's copyright.

©2002-2018 Chess