Skip to main content

Investigating the Identification of Technical Debt Through Code Comment Analysis

  • Conference paper
  • First Online:

Part of the book series: Lecture Notes in Business Information Processing ((LNBIP,volume 291))

Abstract

In order to effectively manage technical debt (TD), a set of indicators has been used by automated approaches to identify TD items. However, some debt items may not be directly identified using only metrics collected from the source code. CVM-TD is a model to support the identification of technical debt by considering the developer point of view when identifying TD through code comment analysis. In this paper, we investigate the use of CVM-TD with the purpose of characterizing factors that affect the accuracy of the identification of TD, and the most chosen patterns by participants as decisive to indicate TD items. We performed a controlled experiment investigating the accuracy of CVM-TD and the influence of English skills and developer experience factors. We also investigated if the contextualized vocabulary provided by CVM-TD points to candidate comments that are considered indicators of technical debt by participants. The results indicated that CVM-TD provided promising results considering the accuracy values. English reading skills have an impact on the TD detection process. We could not conclude that the experience level affects this process. We identified a list of the 20 most chosen patterns by participants as decisive to indicate TD items. The results motivate us continuing to explore code comments in the context of TD identification process in order to improve CVM-TD.

This is a preview of subscription content, log in via an institution.

Buying options

Chapter
USD   29.95
Price excludes VAT (USA)
  • Available as PDF
  • Read on any device
  • Instant download
  • Own it forever
eBook
USD   39.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book
USD   54.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Purchases are for personal use only

Learn about institutional subscriptions

Notes

  1. 1.

    The term “TD item” represents an instance of Technical Debt.

References

  1. Izurieta, C., Vetrò, A., Zazworka, N., Cai, Y., Seaman, C., Shull, F.: Organizing the technical debt landscape. In: 3rd International Workshop on Managing Technical Debt, MTD 2012 – Proceedings, pp. 23–26 (2012)

    Google Scholar 

  2. Ernst, N.A., Bellomo, S., Ozkaya, I., Nord, R.L., Gorton, I.: Measure it? Manage it? Ignore it? Software Practitioners and Technical Debt. In: 10th Joint Meeting on Foundations of Software Engineering - ESEC/FSE 2015, pp. 50–60 (2015)

    Google Scholar 

  3. Alves, N.S.R., Mendes, T.S., Mendonça, M.G., Spínola, R.O., Shull, F., Seaman, C.: Identification and management of technical debt: a systematic mapping study. Inf. Softw. Technol. 70, 100–121 (2016)

    Article  Google Scholar 

  4. Guo, Y., Spínola, R.O., Seaman, C.: Exploring the costs of technical debt management – a case study. Empir. Softw. Eng. 1, 1–24 (2014)

    Google Scholar 

  5. Li, Z., Liang, P., Avgeriou, P., Guelfi, N.: A systematic mapping study on technical debt and its management. J. Syst. Softw. 101, 193–220 (2014)

    Article  Google Scholar 

  6. Mendes, T.S., Almeida, D.A., Alves, N.S.R., Spínola, R.O., Mendonça, M.: VisMinerTD - an open source tool to support the monitoring of the technical debt evolution using software visualization. In: 17th International Conference on Enterprise Information Systems (2015)

    Google Scholar 

  7. Zazworka, N., Spínola, R.O., Vetro’, A., Shull, F., Seaman, C.: A case study on effectively identifying technical debt. In: Proceedings of the 17th International Conference on Evaluation and Assessment in Software Engineering - EASE 2013, pp. 42–47. ACM Press, New York (2013)

    Google Scholar 

  8. Potdar, A., Shihab, E.: An exploratory study on self-admitted technical debt. In: IEEE International Conference on Software Maintenance and Evolution, pp. 91–100 (2014)

    Google Scholar 

  9. Farias, M.A.F., Silva, A.B., Mendonça, M.G., Spínola, R.O.: A contextualized vocabulary model for identifying technical debt on code comments. In: 7th International Workshop on Managing Technical Debt, pp. 25–32 (2015)

    Google Scholar 

  10. Maldonado, E.S., Shihab, E.: Detecting and quantifying different types of self-admitted technical debt. In: 7th International Workshop on Managing Technical Debt, pp. 9–15 (2015)

    Google Scholar 

  11. Alves, N.S.R., Ribeiro, L.F., Caires, V., Mendes, T.S., Spínola, R.O.: Towards an ontology of terms on technical debt. In: Sixth International Workshop on Managing Technical Debt (MTD), pp. 1–7 (2014)

    Google Scholar 

  12. Storey, M., Ryall, J., Bull, R.I., Myers, D., Singer, J.: TODO or to bug : exploring how task annotations play a role in the work practices of software developers. In: ICSE: International Conference on Software Engineering, pp. 251–260 (2008)

    Google Scholar 

  13. Maalej, W., Happel, H.-J.: Can development work describe itself? In: 7th IEEE Working Conference on Mining Software Repositories (MSR), pp. 191–200 (2010)

    Google Scholar 

  14. Steidl, D., Hummel, B., Juergens, E.: Quality analysis of source code comments. In: 21st International Conference on Program Comprehension (ICPC), pp. 83–92. IEEE (2013)

    Google Scholar 

  15. Etzkorn, L.H., Davis, C.G., Bowen, L.L.: The language of comments in computer software: a sublanguage of English. J. Pragmat. 33, 1731–1756 (2001)

    Article  Google Scholar 

  16. Bavota, G., Russo, B.: A large-scale empirical study on self-admitted technical debt. In: 13th Working Conference on Mining Software Repositories – MSR, pp. 315–326 (2016)

    Google Scholar 

  17. Lemos, O.A. de Paula, A.C., Zanichelli, F.C., Lopes, C.V.: Thesaurus-based automatic query expansion for interface-driven code search categories and subject descriptors. In: 11th Working Conference on Mining Software Repositories – MSR, pp. 212–221 (2014)

    Google Scholar 

  18. Host, M., Wohlin, C., Thelin, T.: Experimental context classification: incentives and experience of subjects. In: Proceedings of 27th International Conference on Software Engineering, ICSE 2005, pp. 470–478 (2005)

    Google Scholar 

  19. Salman, I., Misirli, A.T., Juristo, N.: Are students representatives of professionals in software engineering experiments? In: Proceedings of the 37th International Conference on Software Engineering (2015)

    Google Scholar 

  20. Santos, J.A.M., Mendonça, M.G., Pereira, C.: The problem of conceptualization in god class detection: agreement, strategies and decision drivers. J. Softw. Eng. Res. Dev. 2, 1–33 (2014)

    Article  Google Scholar 

  21. Shull, F., Singer, J., Sjoberg, D.: Guide to Advanced Empirical Software Engineering. Springer, London (2008). doi:10.1007/978-1-84800-044-5

    Book  Google Scholar 

  22. Finn, R.H.: A note on estimating the reliability of categorical data. Educ. Psychol. Measur. 30(1), 71–76 (1970). doi:10.1177/001316447003000106. ISBN 0013-1644

    Article  Google Scholar 

  23. Landis, J.R., Koch, G.G.: The measurement of observer agreement for categorical data. Biometrics 33, 159–174 (1977)

    Article  MATH  Google Scholar 

  24. Cohen, J.: Statistical Power Analysis for the Behavioral Sciences, 2nd edn. Lawrence Earlbaum Associates, Hillsdale (1988). http://www.worldcat.org/isbn/-0805802835

  25. Snedecor, G.W., Cochran, W.G.: Statistical Methods, 6th edn. Iowa State University Press, Ames (1967)

    MATH  Google Scholar 

  26. Spínola, R., Zazworka, N., Seaman, C., Shull, F.: Investigating technical debt folklore. In: 5th International Workshop on Managing Technical Debt, pp. 1–7 (2013)

    Google Scholar 

  27. Kruchten, P., Nord, R.L., Ozkaya, I.: Technical debt: from metaphor to theory and practice. IEEE Softw. 29(6), 18–21 (2012)

    Article  Google Scholar 

  28. Wohlin, C., Runeson, P., Höst, M., Ohlsson, M.C., Regnell, B., Wesslén, A.: Experimentation in Software Engineering: An Introduction. Kluwer Academic Publishers, Norwell (2000)

    Book  MATH  Google Scholar 

Download references

Acknowledgements

This work was partially supported by CNPq Universal 2014 grant 458261/2014-9. The authors also would like to thank Methanias Colaço and André Batista for their support in the execution step of the experiment.

Author information

Authors and Affiliations

Authors

Corresponding author

Correspondence to Mário André de Freitas Farias .

Editor information

Editors and Affiliations

Rights and permissions

Reprints and permissions

Copyright information

© 2017 Springer International Publishing AG

About this paper

Cite this paper

de Freitas Farias, M.A., Santos, J.A., Kalinowski, M., Mendonça, M., Spínola, R.O. (2017). Investigating the Identification of Technical Debt Through Code Comment Analysis. In: Hammoudi, S., Maciaszek, L., Missikoff, M., Camp, O., Cordeiro, J. (eds) Enterprise Information Systems. ICEIS 2016. Lecture Notes in Business Information Processing, vol 291. Springer, Cham. https://doi.org/10.1007/978-3-319-62386-3_14

Download citation

  • DOI: https://doi.org/10.1007/978-3-319-62386-3_14

  • Published:

  • Publisher Name: Springer, Cham

  • Print ISBN: 978-3-319-62385-6

  • Online ISBN: 978-3-319-62386-3

  • eBook Packages: Computer ScienceComputer Science (R0)

Publish with us

Policies and ethics