Concise and consistent naming

  • Authors:
  • Florian Deissenboeck;Markus Pizka

  • Affiliations:
  • Institut für Informatik, Technische Universität München, Garching b. München, Germany D-85748;Institut für Informatik, Technische Universität München, Garching b. München, Germany D-85748

  • Venue:
  • Software Quality Control
  • Year:
  • 2006

Quantified Score

Hi-index 0.00

Visualization

Abstract

Approximately 70% of the source code of a software system consists of identifiers. Hence, the names chosen as identifiers are of paramount importance for the readability of computer programs and therewith their comprehensibility. However, virtually every programming language allows programmers to use almost arbitrary sequences of characters as identifiers which far too often results in more or less meaningless or even misleading naming. Coding style guides somehow address this problem but are usually limited to general and hard to enforce rules like "identifiers should be self-describing". This paper renders adequate identifier naming far more precisely. A formal model, based on bijective mappings between concepts and names, provides a solid foundation for the definition of precise rules for concise and consistent naming. The enforcement of these rules is supported by a tool that incrementally builds and maintains a complete identifier dictionary while the system is being developed. The identifier dictionary explains the language used in the software system, aids in consistent naming, and supports programmers by proposing suitable names depending on the current context.