Quando una funzione ha raggiunto la fine della sua vita, aggiungiamo un tag @deprecated nel suo doc-comment per notificare agli altri sviluppatori che dovrebbero smettere di usare questa funzione, e poi un paio di anni dopo viene rimosso.
Stavo solo pensando a un tag @beta per indicare che questo metodo è nuovo di zecca e non è stato ancora testato in una varietà di casi d'uso.
Potresti pensare "puoi scrivere casi d'uso per assicurarne la correttezza!" Certo che puoi, ma è l'API che mi riguarda e come si comporta in casi limite. A volte queste decisioni non sono ovvie finché non hai provato la funzione in una varietà di situazioni. A volte è necessario aggiungere nuovi parametri per coprire più casi d'uso. A volte riordinarle ha senso se si scopre che un argomento è in realtà opzionale e deve essere spostato alla fine (o viceversa).
Aggiungendo il tag @beta , avvisi ad altri sviluppatori che l'API di questo metodo potrebbe ancora cambiare e dovrebbero utilizzarla con estrema cautela. Questo ti dà un controllo più granulare sulla tua API invece di rendere l'intero progetto 'beta'.
Per trarre il massimo vantaggio da questo, tuttavia, IDE e generatori di documentazione dovrebbero raccogliere questo tag.
Che cosa ne pensate voi ragazzi? Potresti vedere questo come utile, è una perdita di tempo, o hai altri modi per affrontare questo?
In passato, ho reso tali metodi "privati" laddove possibile, o li ho preceduti con un carattere di sottolineatura.