What the Fix? A Study of ASATs Rule Documentation - Archive ouverte HAL Accéder directement au contenu
Communication Dans Un Congrès Année : 2024

What the Fix? A Study of ASATs Rule Documentation

Corentin Latappy
  • Fonction : Auteur
  • PersonId : 1218448
Thomas Degueule
Xavier Blanc
Cédric Teyton
  • Fonction : Auteur
  • PersonId : 1218450

Résumé

Automatic Static Analysis Tools (ASATs) are widely used by software developers to diffuse and enforce coding practices. Yet, we know little about the documentation of ASATs, despite it being critical to learn about the coding practices in the first place. We shed light on this through several contributions. First, we analyze the documentation of more than 100 rules of 16 ASATs for multiple programming languages, and distill a taxonomy of the purposes of the documentation-What triggers a rule; Why it is important; and how to Fix an issue-and its types of contents. Then, we conduct a survey to assess the effectiveness of the documentation in terms of its goals and types of content. We highlight opportunities for improvement in ASAT documentation. In particular, we find that the Why purpose is missing in half of the rules we survey; moreover, when the Why is present, it is more likely to have quality issues than the What and the Fix.
Fichier principal
Vignette du fichier
linters.pdf (1.62 Mo) Télécharger le fichier
Origine : Fichiers produits par l'(les) auteur(s)

Dates et versions

hal-04450208 , version 1 (12-02-2024)

Identifiants

Citer

Corentin Latappy, Thomas Degueule, Jean-Rémy Falleri, Romain Robbes, Xavier Blanc, et al.. What the Fix? A Study of ASATs Rule Documentation. 32nd IEEE/ACM International Conference on Program Comprehension (ICPC 2024), Apr 2024, Lisboa, Portugal. ⟨10.1145/3643916.3644404⟩. ⟨hal-04450208⟩

Collections

CNRS
23 Consultations
23 Téléchargements

Altmetric

Partager

Gmail Facebook X LinkedIn More