Ho iniziato a lavorare in una nuova azienda l'anno scorso. Sono abituato ad avere JavaDoc completi con annotazioni sugli edge case (come quello che succede quando null viene passato al metodo).
Sto spingendo per apportare miglioramenti incrementali al metodo JavaDocs : Ogni volta che usi un metodo nel tuo codice e devi sapere come si comporta in un caso limite, aggiornalo. Se si scopre che il metodo fa più di quanto indicato nel nome del metodo o di JavaDoc, aggiornarlo.
Il problema
Questo ha il potenziale di "sporcare" le richieste di pull, facendolo apparire come una richiesta pull più grande di quanto non sia. Questo può portare a un paio di problemi (persone che non vogliono rivederlo proprio in quel momento. Rende più difficile vedere quali sono i cambiamenti effettivi).
Opzioni a cui ho pensato
- Fai un PR separato
- Aggiunge l'attrito allo sforzo di migliorare JavaDocs
- Plugin BitBucket per contrassegnare quali file contengono solo modifiche ai commenti
- Impossibile trovare un tale plug-in
Spero che alcuni di voi abbiano cercato di spingere per sforzi come questo con successo.