• DocumentCode
    2333408
  • Title

    Code convention adherence in evolving software

  • Author

    Smit, Michael ; Gergel, Barry ; Hoover, H. James ; Stroulia, Eleni

  • Author_Institution
    Dept. of Comput. Sci., Univ. of Alberta, Edmonton, AB, Canada
  • fYear
    2011
  • fDate
    25-30 Sept. 2011
  • Firstpage
    504
  • Lastpage
    507
  • Abstract
    Maintainability is a desired property of software, and a variety of metrics have been proposed for measuring it, focusing on different notions of complexity and code readability. Many practices have been proposed to improve maintainability through code refactorings: improving the cohesion, simplification of interfaces, renamings to improve understandability. Code conventions are a body of advice on lexical and syntactic aspects of code, aiming to standardize low-level code design under the assumption that such a systematic approach will make code easier to read, understand, and maintain. We present the first stage in our examination of code-convention adherence practices as a proxy measurement for maintainability. Based on a preliminary survey of software engineers, we identify a set of coding conventions that most relate to maintainability. Then we devise a “convention adherence” metric, based on the number and severity of violations of a defined coding convention. Finally, we analyze several open-source projects according to this metric to better understand how consistent different teams are with respect to adopting and conforming to code conventions.
  • Keywords
    public domain software; software maintenance; software metrics; code convention adherence; code readability notion; code refactoring; coding convention; complexity notion; convention adherence metric; evolving software; low-level code design; open-source project; proxy measurement; software maintainability; software metrics; Best practices; Complexity theory; Correlation; Encoding; Maintenance engineering; Measurement; Software;
  • fLanguage
    English
  • Publisher
    ieee
  • Conference_Titel
    Software Maintenance (ICSM), 2011 27th IEEE International Conference on
  • Conference_Location
    Williamsburg, VI
  • ISSN
    1063-6773
  • Print_ISBN
    978-1-4577-0663-9
  • Electronic_ISBN
    1063-6773
  • Type

    conf

  • DOI
    10.1109/ICSM.2011.6080819
  • Filename
    6080819