Cosa fai quando la tua convenzione sui nomi si scontra con la tua lingua?

Ok, questa è una di quelle piccole cose che mi hanno sempre infastidito. In genere non abbrevia gli identificativi e l'unica volta che utilizzo un identificatore breve (ad es. i) È per un ciclo stretto. Quindi mi irrita quando sto lavorando in C ++ e ho una variabile che deve essere nominata operatoro classe devo aggirarla o usare un'abbreviazione, perché finisce per sporgere. Avvertenza: questo può succedere a me in modo sproporzionato spesso perché lavoro molto nella progettazione del linguaggio di programmazione, in cui gli oggetti di dominio possono rispecchiare concetti nel linguaggio host e causare inavvertitamente scontri.

Come lo faresti? Abbreviare? ( op) Errore ortografico? ( klass) Qualcos'altro? ( operator_)

1. Accetta che potresti dover apportare lievi modifiche alla convenzione di denominazione, come l'aggiunta di lettere maiuscole. È meglio accettarlo al più presto in modo che tutto il codice successivo sia coerente.

2. Valuta di essere più specifico. Parole tendono ad essere abbastanza ampio, in modo da restringere classverso il basso per demonstrationClassnon solo funziona in tutto i problemi, ma aumenta anche la leggibilità.

Non è qualcosa che ho riscontrato, ma se mi trovassi in una situazione del genere, proverei a risolverlo con le seguenti opzioni, in ordine.

1. Prova a trovare un sinonimo.
2. (specialmente per le variabili) prova a trovare un prefisso o postfisso
3. (specialmente per le classi) cambia la prima lettera in maiuscolo e dimentica la regola di codifica secondo cui i nomi non dovrebbero differire solo nel caso. Questa opzione, probabilmente userei solo se il conflitto è con una parola chiave.
4. Usa un'abbreviazione.

La lingua vince; non puoi superare in astuzia il compilatore (ignorando le abominazioni come PL / 1 IF IF = THEN THEN THEN = ELSE ELSE ELSE = IF END, ma poi PL / 1 non ti farebbe in primo luogo porre la domanda). Fondamentalmente, devi seguire le regole della lingua e devi trovare un'alternativa alle parole chiave della lingua per il tuo uso personale o trovare una lingua alternativa.

Quindi, tranne in circostanze molto insolite, ti adatti alla lingua, non viceversa.

Invece di abbreviare che ne dici di allungare? Se stai implementando un costrutto di classe in un linguaggio Foo, che ne dici di usare FooClass e foo_class? (Modulo qualunque siano le tue preferenze di involucro).

Alcune delle abbreviazioni che ho usato class, in ordine di frequenza:

• cls
• clss
• clazz
• theClass
• aClass

Se so quale classe Classrappresenta l' istanza, potrei includerla nel nome della variabile:

• stringClass = Class.forName("java.lang.String");

In C e C ++, le parole chiave sono tutte minuscole e la lingua fa distinzione tra maiuscole e minuscole, quindi di tanto in tanto premere il tasto Maiusc e molti problemi scompaiono.

In Modula 2, le parole chiave sono tutto in maiuscolo - ma fino a quando i dati identificativi sono alcune lettere minuscole la differenza è evidente e scontri impossibile.

Inoltre, le convenzioni di denominazione assolutamente in una certa misura devono riflettere le convenzioni normali del linguaggio che stai usando, quindi scrivo sicuramente "myClass" in Java dove probabilmente scrivo "My_Class" in C ++.

Fondamentalmente, non stai solo scrivendo per il compilatore, ma ciò che la gente trova leggibile dipende in una certa misura dal contesto e dalle aspettative correlate.

Non mi capita spesso di imbattermi in questo, ma quando lo faccio tende ad essere un problema perché utilizzo Delphi e ti consente di aggirare questo problema anteponendo un & all'identificatore. Quindi "class" non è un identificatore valido, ma "& class" lo è.

Vorrei aggiungere una sorta di namespace al nome della variabile. Ad esempio, supponiamo che tu abbia un modulo chiamato user, quindi modificherei l'operatore nome variabile in qualcosa di simile a user_operator o userOperator.

modifica o modifica la mia convenzione di denominazione