Shortcomings of Class-level Documentation: A Survey

Jianwei Wu; Jining Yu; David Shepherd; James Clause

Shortcomings of Class-level Documentation: A Survey

Software Engineering 2022-05-09 v1

Authors: Jianwei Wu , Jining Yu , David Shepherd , James Clause

Abstract

To better understand the shortcomings of class-level documentation, we conducted a survey of 167 experienced software developers. The survey focused on the participants' programming-related information needs and how often class-level documentation satisfies such needs.

Keywords

software refactoring software engineering software engineering education

Cite

@article{arxiv.2205.03344,
  title  = {Shortcomings of Class-level Documentation: A Survey},
  author = {Jianwei Wu and Jining Yu and David Shepherd and James Clause},
  journal= {arXiv preprint arXiv:2205.03344},
  year   = {2022}
}

Related papers

View all related →