È buona norma aggiungere commenti sopra i campi generati?

-1

Ogni volta che consento a Eclipse di generare un campo (il più delle volte un UID della versione seriale), aggiunge un commento sopra di esso. Esempio:

/**
 * 
 */
private static final long serialVersionUID = 6347144762354188381L;

Questo accade perché questo comportamento è stato per qualche motivo ritenuto opportuno dagli sviluppatori di Eclipse. So come disabilitarlo, ma non è questo il punto di questa domanda. Ho sviluppato in Java per qualcosa come dieci anni e ho una buona comprensione di come appare un codice buono e ben commentato. Tuttavia, raramente aggiungo commenti sopra i campi e non ho visto neanche molti di quelli in natura.

La mia domanda è, qual è la ragione per cui Eclipse lo fa? È perché è una buona pratica per commentare i campi generati ? In tal caso, quali informazioni dovrebbe contenere il commento?

    
posta JohnEye 07.06.2018 - 17:49
fonte

2 risposte

1

La prassi generale è in ordine:

  • avere un nome significativo di tutto, quindi non abbiamo bisogno di un muro di testo per spiegare cosa è quando è possibile (il più delle volte)
  • aggiungi un commento quando necessario

Nel caso specifico hai dimostrato che si tratta di un serialVersionUID: chiunque abbia una competenza di base in Java potrebbe sapere cosa significa, aggiungendo commento non aggiungere informazioni utili. L'aggiunta dell'annotazione @Generated eliminerebbe la necessità di spiegare il campo generato da Eclipse. Inoltre dichiarerebbe che il valore è stato generato casualmente e non scelto dall'utente, il che significa che non lo gestisci e probabilmente non cambierà il valore se cambi la classe. Probabilmente puoi impostare da qualche parte di non aggiungere il commento di blocco vuoto predefinito durante la generazione del campo.

Anche alcuni strumenti (come wsimport) che generano il codice generalmente aggiungono commenti che sono stati generati e con quale versione, che è importante se si riscontrano problemi.

    
risposta data 08.06.2018 - 10:07
fonte
0

I commenti generati automaticamente non sono solo commenti, sono anche commenti Javadoc. Quindi se esegui Javadoc sul tuo progetto, dovresti ottenere una pagina web amichevole che documenta tutte le classi, i metodi e i campi del tuo codice.

Ma con tutti i campi che hanno una documentazione vuota, perché non li hai riempiti.

    
risposta data 08.06.2018 - 14:37
fonte

Leggi altre domande sui tag