TODO or to bug

Storey, Margaret-Anne; Ryall, Jody; Bull, R. Ian; Myers, Del; Singer, Janice

doi:10.1145/1368088.1368123

Cited by 81 publications

(26 citation statements)

References 23 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…As in case of the "Number Range" directive, we did find instances where the use of an enumeration where each enum-value is associated with a string, would be an improvement. We further found instances of "String Format" directives where there is an obviously more appropriate type (such as File for denoting files 29 ).…”

Section: Discussionmentioning

confidence: 86%

“…They examined 1050 comments from three different operating system kernels and thereafter built a taxonomy of comments that has four axes: the content, the audience, the related source element and the evolution in time. Storey et al [29] and Ying et al [39] also did empirical work related to source code documentation. They focused on source code comments that represent so called task annotations (e.g.…”

Section: Code Commentsmentioning

confidence: 99%

See 1 more Smart Citation

What should developers be aware of? An empirical study on the directives of API documentation

Monperrus¹,

Eichberg²,

Tekes³

et al. 2011

Empir Software Eng

View full text Add to dashboard Cite

Application Programming Interfaces (API) are exposed to developers in order to reuse software libraries. API directives are natural-language statements in API documentation that make developers aware of constraints and guidelines related to the usage of an API. This paper presents the design and the results of an empirical study on the directives of API documentation of object-oriented libraries. Its main contribution is to propose and extensively discuss a taxonomy of 23 kinds of API directives.

show abstract

Section: Discussionmentioning

confidence: 86%

Section: Code Commentsmentioning

confidence: 99%

What should developers be aware of? An empirical study on the directives of API documentation

Monperrus¹,

Eichberg²,

Tekes³

et al. 2011

Empir Software Eng

View full text Add to dashboard Cite

show abstract

“…Developers often write "TODO comments" like // TODO: fix this to mark parts of source code which need their attention [41]. IDEs can then try to 43 parse and display these notes in a task list window.…”

Section: Maintenance Notesmentioning

confidence: 99%

Recording concerns in source code using annotations

Sulír

Nosal

Porubãn

2016

Computer Languages, Systems & Structures

View full text Add to dashboard Cite

A concern can be characterized as a developer's intent behind a piece of code, often not explicitly captured in it. We discuss a technique of recording concerns using source code annotations (concern annotations). Using two studies and two controlled experiments, we seek to answer the following 3 research questions: 1) Do programmers' mental models overlap? 2) How do developers use shared concern annotations when they are available? 3) Does using annotations created by others improve program comprehension and maintenance correctness, time and confidence? The first study shows that developers' mental models, recorded using concern annotations, overlap and thus can be shared. The second study shows that shared concern annotations can be used during program comprehension for the following purposes: hypotheses confirmation, feature location, obtaining new knowledge, finding relationships and maintenance notes.The first controlled experiment with students showed that the presence of annotations significantly reduced program comprehension and maintenance time by 34%. The second controlled experiment was a differentiated replication of the first one, focused on industrial developers. It showed a 33% significant improvement in correctness. We conclude that concern annotations are a viable way to share developers' thoughts.

show abstract

“…Developers often write "TODO comments" like // TODO: fix this to mark parts of source code which need their attention [25]. IDEs can then try to parse and display these notes in a task list window.…”

Section: F Maintenance Notesmentioning

confidence: 99%

Sharing Developers' Mental Models through Source Code Annotations

Sulír

Nosal

2015

Annals of Computer Science and Information Systems

View full text Add to dashboard Cite

Abstract-Context: Developers possess mental models containing information far beyond what is explicitly captured in the source code. Objectives: We investigate the possibility to use source code annotations to capture parts of the developers' mental models and later reuse them by other programmers during program comprehension and maintenance. Method: We performed two studies and a controlled experiment. Results: Developers' mental models overlap and thus can be shared. Possible use cases of shared annotations are hypotheses confirmation, feature location, obtaining new knowledge, finding relationships and maintenance notes. In the experiment, the presence of annotations reduced program comprehension and maintenance time by 34%. Conclusion: Annotations are a viable way to share programmers' thoughts.

show abstract

TODO or to bug

Cited by 81 publications

References 23 publications

What should developers be aware of? An empirical study on the directives of API documentation

What should developers be aware of? An empirical study on the directives of API documentation

Recording concerns in source code using annotations

Sharing Developers' Mental Models through Source Code Annotations

Contact Info

Product

Resources

About