convenzioni di denominazione / standard di codifica per i metodi in un servizio

Question

convenzioni di denominazione / standard di codifica per i metodi in un servizio

#1 da (3 voti)

1

Al lavoro, abbiamo degli "argomenti" su come nominare stili / convenzioni. Immagina di avere un servizio chiamato UserSettingsService . Questo ha 2 metodi, uno per ottenere le impostazioni dell'utente e uno per salvare. Definiresti il metodo per includere esattamente ciò che fa esattamente, come .getUserSettings() o solo get() ?

Un argomento è che la parte UserSettings è implicita nel nome del servizio. L'altro argomento è che un nome di metodo completo di getUserSettings() non è ambiguo. C'è un modo "corretto" per farlo?

coding-standards naming-standards

posta Karl Cassar 22.09.2016 - 10:49

fonte

1 risposta

Leggi altre domande sui tag coding-standards naming-standards

L'omissione dell'attesa della parola chiave una volta nello stack di chiamate interrompe il comportamento asincrono dell'intero stack? omega perché K + N meglio di N

score 3 · Accepted Answer

La solita convenzione non è quella di ripetere il nome della classe nel metodo

cioè Customer.CustomerName == male

Nel tuo caso, UserSettingsService suona come un repository, che contiene solo le impostazioni dell'utente. Quindi avrei metodi come:

UserSettingsRepository.GetById(string id)
UserSettingsRepository.GetAll()

etc etc

Se hai più di un tipo di impostazioni potresti includere il tipo:

SettingsRepository.GetAllUserSettings();

Oppure potresti avere una "risorsa":

SettingsRepository.UserSettings.GetAll();

Modifica

Un altro metodo per risolvere "argomenti" sulle convenzioni di denominazione è organizzare una Risoluzione definitiva nella sessione Convenzioni di denominazione . Queste sessioni dovrebbero svolgersi in un pub. Per proporre o obiettare uno standard di denominazione devi prima prendere un drink. Tradizionalmente, il membro più anziano della squadra inizia la riunione proponendo la notazione ungherese.