Sta usando parole non comuni come nomi di variabili descrittive accettabili?

1

Sto implementando una macchina a stati finiti in Python 2.7, e sto considerando di usare una parola inglese che io non si vede comunemente nel codice: "stimolo". Ho una funzione di transizione che accetta un qualche tipo di input e lo stato corrente per decidere su quale stato passare:

def transition(self, stimulus):

    # each state class has a decode_next_state() method to decide
    # what state to transition to based on the input
    next_state = self.current_state.decode_next_state(stimulus)

Non sono sicuro dell'uso della parola "stimolo", perché non è qualcosa che vedo comunemente nel codice. In questo caso, potrebbe trattarsi di una risposta dal sistema in prova, potrebbe essere un errore di timeout o potrebbe essere un altro codice di errore. Voglio che il nome sia descrittivo, ma "input" è un nome di funzione incorporato, non credo che "message" descriva correttamente i diversi tipi di dati, e alternative come "impeto" sono ancora meno comuni.

Quanto dovrei essere preoccupato che questa non sia una parola molto comune? Lavoro in un posto di lavoro linguisticamente e culturalmente diversificato, con parlanti non madrelingua inglesi, quindi voglio assicurarmi di usare un linguaggio chiaro.

Solo per assicurarmi che la mia domanda sia chiara: ho fornito un esempio di dove sono incerto sull'adeguatezza di una parola che non è comune nel codice, ma non voglio necessariamente suggerimenti di parole da usare in questo caso. Sto cercando un input più generale sull'idea di usare parole descrittive ma non comuni, vs favorire parole più comuni per rendere il codice più facile da capire.

TL; DR
In generale, dovrei preferire parole e costrutti linguistici comuni per migliorare la manutenibilità / comprensibilità del codice, anche quando una parola meno comune descrive meglio le mie variabili?

    
posta skrrgwasme 26.10.2016 - 20:00
fonte

1 risposta

10

I nomi dei parametri formali dovrebbero riflettere correttamente il dominio in cui operano.

Nel tuo caso, la parola "stimolo" è un termine comunemente usato e compreso nel dominio delle macchine a stati finiti, quindi il suo uso è appropriato qui.

    
risposta data 26.10.2016 - 20:24
fonte

Leggi altre domande sui tag