Live software documentation of design pattern instances.

Design patterns Liveness Software documentation

Journal

PeerJ. Computer science
ISSN: 2376-5992
Titre abrégé: PeerJ Comput Sci
Pays: United States
ID NLM: 101660598

Informations de publication

Date de publication:
2024
Historique:
received: 03 02 2024
accepted: 06 05 2024
medline: 24 9 2024
pubmed: 24 9 2024
entrez: 24 9 2024
Statut: epublish

Résumé

Approaches to documenting the software patterns of a system can support intentionally and manually documenting them or automatically extracting them from the source code. Some of the approaches that we review do not maintain proximity between code and documentation. Others do not update the documentation after the code is changed. All of them present a low level of This work proposes an approach to improve the understandability of a software system by documenting the design patterns it uses. We regard the To evaluate this approach, we conducted a controlled experiment with 21 novice developers. We asked participants to complete three tasks that involved

Sections du résumé

Background UNASSIGNED
Approaches to documenting the software patterns of a system can support intentionally and manually documenting them or automatically extracting them from the source code. Some of the approaches that we review do not maintain proximity between code and documentation. Others do not update the documentation after the code is changed. All of them present a low level of
Approach UNASSIGNED
This work proposes an approach to improve the understandability of a software system by documenting the design patterns it uses. We regard the
Results UNASSIGNED
To evaluate this approach, we conducted a controlled experiment with 21 novice developers. We asked participants to complete three tasks that involved

Identifiants

pubmed: 39314703
doi: 10.7717/peerj-cs.2090
pii: cs-2090
pmc: PMC11419627
doi:

Types de publication

Journal Article

Langues

eng

Pagination

e2090

Informations de copyright

© 2024 Lemos et al.

Déclaration de conflit d'intérêts

The authors declare that they have no competing interests.

Auteurs

Filipe Lemos (F)

Faculty of Engineering, University of Porto, Porto, Portugal.

Filipe F Correia (FF)

Faculty of Engineering, University of Porto, Porto, Portugal.
INESC TEC, Porto, Portugal.

Ademar Aguiar (A)

Faculty of Engineering, University of Porto, Porto, Portugal.
INESC TEC, Porto, Portugal.

Paulo G G Queiroz (PGG)

INESC TEC, Porto, Portugal.
Universidade Federal Rural do Semi-Árido, Mossoró, RN, Brazil.

Classifications MeSH