flowable / flowable/flowable-engine
Add CheckReturnValue to queries
- Lingua principale
- Java
- Stelle
- 9.5k
- Fork
- 2.9k
- Merge medio
- 7h 8m
- PR unite (30g)
- 2
Descrizione
It allows to detect incorrect API usage through static checkers in IDEs or Findbugs.
Findbugs and the IDEs work in a nice way and one can define an annotation named `@CheckReturnValue` in their own package and the checkers will honer it. There won't be any need for a dependency to a 3rd party.
Marking a class with `@CheckReturnValue` will apply that to all of it's method. In order to ignore a particular method one can annotate it with an annotation named `@CanIgnoreReturnValue`.
All this would be beneficial for a better developer experience with the Flowable Java API
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
Iniziare individuando le classi delle query dell’API Java di Flowable e verificando come FindBugs e gli IDE riconoscono @CheckReturnValue e @CanIgnoreReturnValue. Determinare i metodi di query per i quali è necessario utilizzare i valori restituiti e le eccezioni che dovrebbero essere consentite. Il lavoro è completato quando le annotazioni vengono applicate in modo coerente e i verificatori statici riconoscono l’uso previsto dell’API.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- api, developer-experience
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100