github / github/codeql

Java: Make it more explicit when CodeQL classes and predicates only apply to Kotlin

Ouverte
#14,556 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
question
Langage dominant
CodeQL
Étoiles
10.1k
Forks
2.1k
Merge moyen
2 j 15 h
PR mergées (30 j)
141

Description

For multiple CodeQL classes (and possibly predicates) for Java / Kotlin it is not obvious that they only apply to Kotlin. This makes it difficult to read the documentation and decide if you have to specially treat a certain CodeQL class, or even what the CodeQL class represents in the first place.

A good (negative) example for this is [`PropertyRefExpr`](https://codeql.github.com/codeql-standard-libraries/java/semmle/code/java/Expr.qll/type.Expr$PropertyRefExpr.html). Neither the name nor the documentation give any indication that this is Kotlin-specific. You can only guess this if you have used Kotlin before and the term "property" in combination with "`get`" and "`set`" sound familiar.

Some Kotlin-specific classes seem to be prefixed with `Kotlin` or `Kt` (see [index](https://codeql.github.com/codeql-standard-libraries/java/index.html#K)), but this is not consistent.

I assume this general issue might affect other languages supported by CodeQL as well, such as C / C++ and JavaScript / TypeScript.

Maybe it would be useful if CodeQL QLDoc comments supported some kind of "tag" which would be shown in the documentation whenever the name of the class or predicate is displayed, similar to how the Javadoc displays Preview features (see for example [Java 21 `FormatProcessor`](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/FormatProcessor.html)).
Or alternatively it would be good if a certain prefix such as "Kt" would be used consistently.

What do you think?

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start with the linked PropertyRefExpr entry in the Java standard-library documentation and the standard-library index. Compare how Kotlin-specific classes are named and presented, including Kt- and Kotlin-prefixed entries. Done means an agreed convention or documentation mechanism is defined for identifying language-specific classes and predicates.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java, kotlin
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.