Diff è un termine ben compreso, o dovrei nominarlo Differenziare?

Question

Diff è un termine ben compreso, o dovrei nominarlo Differenziare?

#1 da (5 voti)
#2 da (1 voti)
#3 da (0 voti)

1

Ho una classe che controlla le differenze. Potrei chiamare questo

class ViolationDiffer
    public IEnumerable<ViolationChange> Diff(
        IEnumerable<Violation> old,
        IEnumerable<Violation> new
    );

o

class ViolationDifferentiator
    public IEnumerable<ViolationChange> Differentiate(
        IEnumerable<Violation> old,
        IEnumerable<Violation> new
    );

Per diff due file di testo, è un posto così comune, che suppongo che quasi tutti capiscano cosa ha fatto.

Nello spirito di essere espliciti, Differentiate è proprio questo. C'è una regola per quando un termine è appropriato per accorciare, come in, la versione abbreviata è usata verbalmente forse?

c# coding-standards naming

posta Chris Wohlert 21.09.2017 - 10:22

fonte

3 risposte

1

il mio suggerimento sarebbe

class ViolationDifferences
    public IEnumerable<ViolationChange> FindBetween(
        IEnumerable<Violation> old,
        IEnumerable<Violation> new
    );

che legge nel tuo codice come

 IEnumerable<ViolationChange> differences =
       new ViolationDifferences().FindBetween(old, new);

risposta data 21.09.2017 - 12:10

fonte

0

Un'alternativa (matematica) potrebbe essere Delta .

Penso che non ci sia una regola rigida quando abbreviare e quando no. Dipende da chi deve leggere (e usare) il tuo codice (il tuo pubblico). Se si assume che un'abbreviazione sia accettata, è opportuno utilizzarla.

Un altro fattore è la frequenza con cui viene utilizzato questo metodo. Più comunemente è usato, più appropriato è abbreviare.

risposta data 21.09.2017 - 11:07

fonte

Leggi altre domande sui tag c# coding-standards naming

Crittografa dati nel codice o stored procedure? Differenza tra "codice di sistema" e "codice dell'applicazione"

score 5 · Accepted Answer

Utilizza Diff e Differ , non Differentiate e Differentiator . I primi sono effettivamente diventati termini tecnici nella programmazione, non nelle abbreviazioni.

Per me, Differentiate è molto meno chiaro di Diff , e non potrei nemmeno dire con certezza che questo è il significato di "diff" in origine.