The commenting practice of open source

ABSTRACT

The development processes of open source soft-ware are different from traditional closed source development processes. Still, open source software is frequently of high quality. This raises the question of how and why open source software creates high quality and whether it can maintain this quality for ever larger project sizes. In this paper, we look at one particular quality indicator, the density of comments in open source software code. We find that successful open source projects follow a consistent practice of documenting their source code, and we find that the comment density is independent of team and project size.

REFERENCES

• 1: Amit Deshpande, Dirk Riehle. "The Total Growth of Open Source." In Proceedings of Fourth Conference on Open Source Systems. Springer Verlag, 2008. Page 197--209.
• 2: Diomidis Spinellis. "A Tale of Four Kernels." In Proceedings of the 2008 International Conference on Software Engineering (ICSE '08). IEEE Press, 2008. Page 381--390.
• 3: Lutz Prechelt. "Are Scripting Languages any Good? A Validation of Perl, Python, Rexx, and Tcl against C, C++, and Java." Advances in Computers 57 (2003). Page 207--271.
• 4: N. E. Fenton. Software Metrics: A Rigorous and Practical Approach. Thomson Computer Press, 1996.
• 5: Marius Sundbakken. Assessing the Maintainability of C++ Source Code. M.S. Thesis, Washington State University, 2001.
• 6: Harvey Siy, Lawrence Votta. "Does the Modern Code Inspection have Value?" In Proceedings of the 17th IEEE International Conference on Software Maintenance (ICSM '01). IEEE Press, 2001. Page 281--290.
• 7: Carlo Daffara. "How Many Stable and Active Libre Software Projects?" See http://flossmetrics.org/news/11.
• 8: Mahmoud Elish, Jeff Offutt. "The Adherence of Open Source Java Programmers to Standard Coding Practices." In Proceedings of the 6th IASTED International Conference Software Engineering and Applications (SEA '02). Page 193--198.
• 9: Ohloh, Inc. See http://www.ohloh.net.
• 10: Ohloh, Inc. Ohloh API. See http://www.ohloh.net/api.
• 11: Ohloh, Inc. ohcount. See http://labs.ohloh.net/ohcount.
• 12: Philipp Hofmann, Dirk Riehle. "A Statistic for Calculating Commit Size Probabilities in Open Source Projects." Technical Report, forthcoming.
• 13: Lutz Prechelt. "An empirical comparison of C, C++, Java, Perl, Python, Rexx, and Tcl for a search/string-processing program." Technical Report 2000--5, Universität Karlsruhe, Fakultät für Informatik, Germany, March 2000.
• 14: Amit Deshpande, Dirk Riehle. "Continuous Integration in Open Source Software Development." In Proceedings of the Fourth Conference on Open Source Systems (OSS 2008). Springer Verlag, 2008. Page 273--280.
• 15: Barry W. Boehm. "A spiral model of software development and enhancement." Computer vol. 21, no. 5 (May 1988). Page 61--72.
• 16: Kent Beck. Extreme Programming Explained: Embrace Change. Addison Wesley, 1998.
• 17: B. Fluri, M. Wümrsch, and H.C. Gall, "Do Code and Comments Co-evolve? On the Relation between Source Code and Comment Changes," Proc. 14th Working Conf. Reverse Eng., IEEE CS Press, 2007, pp. 70--79.
• 18: Oliver Arafat, Dirk Riehle. In Companion to Proceedings of the 31st International Conference on Software Engineering (ICSE 2009). IEEE Press, 2009. Page 195--198.

INDEX TERMS

Primary Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
      D.2.8 Metrics

General Terms:
Documentation, Languages, Measurement

Keywords:
comment density, data mining, empirical software engineering, open source, software evolution