Preliminary Report on Empirical Study of Repeated Fragments in Internal Documentation
Milan Nosáľ, Jaroslav Porubän
Citation: Proceedings of the 2016 Federated Conference on Computer Science and Information Systems, M. Ganzha, L. Maciaszek, M. Paprzycki (eds). ACSIS, Vol. 8, pages 1573–1576 (2016)
Abstract. In this paper we present preliminary results of an empirical study, in which we used copy/paste detection (PMD CPD implementation) to search for repeating documentation fragments. The study was performed on 5 open source projects, including Java 8 SDK sources. The study shows that there are many occurrences of copy-pasting documentation fragments in the internal documentation, e.g., copy-pasted method parameter description. Besides these, many of the copy-pasted fragments express some domain or design concern, e.g., that the method is obsolete and deprecated. Therefore the study indicates that the cross-cutting concerns are present in the internal documentation in form of documentation phrases.
- V. Vranić, J. Porubän, M. Bystrický, T. Frťala, I. Polášek, M. Nosáľ, and J. Lang, “Challenges in preserving intent comprehensibility in software,” Acta Polytechnica Hungarica, vol. 12, no. 7, pp. 57–75, 2015. http://dx.doi.org/10.12700/aph.12.7.2015.7.4.
- J. Kollár, M. Sičák, and M. Spišiak, “Towards Machine Mind Evolution,” in 2015 Federated Conference on Computer Science and Information Systems, ser. FedCSIS 2015, Sept 2015. http://dx.doi.org/10.15439/2015F210 pp. 985–990.
- J. Juhár and L. Vokorokos, “A review of source code projections in integrated development environments,” in 2015 Federated Conference on Computer Science and Information Systems, ser. FedCSIS 2015, Sept 2015. http://dx.doi.org/10.15439/2015F289 pp. 923–927.
- E. Pietriková and S. Chodarev, “Profile-driven source code exploration,” in 2015 Federated Conference on Computer Science and Information Systems, ser. FedCSIS 2015, Sept 2015. http://dx.doi.org/10.15439/2015F238 pp. 929–934.
- R. Táborský and V. Vranić, “Feature Model Driven Generation of Software Artifacts,” in 2015 Federated Conference on Computer Science and Information Systems, ser. FedCSIS 2015, Sept 2015. http://dx.doi.org/10.15439/2015F364 pp. 1007–1018.
- M. Nosáľ and J. Porubän, “Reusable software documentation with phrase annotations,” Central European Journal of Computer Science, vol. 4, no. 4, pp. 242–258, 2014. http://dx.doi.org/10.2478/s13537-014-0208-3.
- M. Horie and S. Chiba, “Tool Support for Crosscutting Concerns of API Documentation,” in Proceedings of the 9th International Conference on Aspect-Oriented Software Development, ser. AOSD ’10. New York, NY, USA: ACM, 2010. http://dx.doi.org/10.1145/1739230.1739242. ISBN 978-1-60558-958-9 pp. 97–108.
- V. Vranić and B. Kuliha, “Realizing changes by aspects at the design level,” in Proceedings of the 2015 IEEE 19th International Conference on Intelligent Engineering Systems, ser. INES 2015, Sept 2015. http://dx.doi.org/10.1109/INES.2015.7329736 pp. 369–374.
- J. Genči, About One Way to Discover Formative Assessment Cheating. Cham: Springer International Publishing, 2015, pp. 83–90. ISBN 978-3-319-06764-3. http://dx.doi.org/10. 1007/978-3-319-06764-3_11
- W. Maalej and M. P. Robillard, “Patterns of Knowledge in API Reference Documentation,” IEEE Transactions on Software Engineering, vol. 39, no. 9, pp. 1264–1282, Sept 2013. http://dx.doi.org/10.1109/TSE.2013.12.
- L. Shi, H. Zhong, T. Xie, and M. Li, “An Empirical Study on Evolution of API Documentation,” in Proceedings of the 14th International Conference on Fundamental Approaches to Software Engineering: Part of the Joint European Conferences on Theory and Practice of Software, ser. FASE’11/ETAPS’11. Berlin, Heidelberg: Springer-Verlag, 2011. http://dx.doi.org/10.1007/978-3-642-19811-3_29. ISBN 978-3-642-19810-6 pp. 416–431.