Ciao Simone,
non è una idea nuova, ma è stata affrontata diversamente dalla tua proposta.

L'obiezione più semplice è: come fa uno sviluppatore a sapere che l'API è 
instabile se non c'è scritto niente?
D'altro canto, se dobbiamo documentare tutte le API instabili, perché allora 
dover annotare anche quelle stabili?

L'assunto è di considerare le API come stabili, filosofia che probabilmente si 
scontra con NodeJS :)

Alcuni esempi sono @Beta di Guava e @OptIn di Kotlin
https://github.com/google/guava#important-warnings
https://kotlinlang.org/docs/reference/opt-in-requirements.html

Ciao,
Vasco

    Il mercoledì 10 giugno 2020, 10:19:22 CEST, Simone Bordet 
[email protected] [it-torino-java-jug] 
<[email protected]> ha scritto:  
 
     
Ciao,

qualcuno ha mai visto/usato delle API (annotazioni o altro) per
marcare delle API come "stabili"?

E se sì, esiste una toolchain associata, per esempio un Maven Plugin
che controlli l'esistenza di queste annotazioni e confronti due
versioni? (Sì, conosco clirr)
E magari supporto in javadoc?

Qualcosa di simile a
https://nodejs.org/docs/latest-v13.x/api/documentation.html#documentation_stability_index.
Anche se non so come sia fatto in NodeJS (non credo annotazioni).

Mi basterebbe una annotazione tipo @API(since="1.0.1") per indicare
una API stabile.
Se non c'è l'annotazione è instabile.
Se c'è @Deprecated è deprecata.

Grazie!

-- 
Simone Bordet
---
Finally, no matter how good the architecture and design are,
to deliver bug-free software with optimal performance and reliability,
the implementation technique must be flawless. Victoria Livschitz

    

Reply via email to