Ordine di soggetti e modificatori nei nomi di variabili

Stai pensando lungo le linee giuste. La maggior parte delle persone preferisce i nomi che possono leggere nella loro testa e farlo sembrare vicino all'inglese normale.

Tuttavia, il fatto che tu abbia difficoltà con le liste lunghe in intellisense non è un problema di denominazione delle variabili, è un problema di dimensioni della classe. Quando inizi a dover distinguere per un prefisso, è un buon segno che devi dividere il prefisso nella sua entità in qualche modo. Ad esempio, Container.Area[INNER] . Usa le caratteristiche della lingua, ecco perché sono lì.

Nelle mie API uso sempre nomi che descrivono ciò che mi aspetto che l'utente digiti: TotalArea invece di AreaTotal , ma WallCount invece di CountWall , poiché gli ultimi esempi sono inglesi impropri.

L'uso di modificatore soggetto è qualcosa che i progettisti fanno solo per soddisfare IntelliSense, in quanto digitando Area si otterrebbe quindi un elenco di sole cose che riguardano l'area - il che è bello - ma ciò non garantire l'utilizzo di nomi strani. Un'opzione molto migliore sarebbe separare le proprietà di un'area in un oggetto Area separato. Ciò rende l'API più pulita, la classe più corta e migliora la riusabilità e la testabilità. La tua classe di esempio diventerebbe quindi:

WallThickness
Height
Length
Width
Area
Volume

Per concludere: usa l'ordine delle parole che userai quando lo scrivi in inglese normale. Se si dispone di più proprietà, campi (e metodi) prefissati, prendere in considerazione la possibilità di raggruppare tali membri in una classe correlata. Ciò migliora la manutenibilità (testabilità e riusabilità), consente a IntelliSense di suggerire solo i membri dell'area pertinenti dopo aver digitato Area. e rende gli oggetti corrispondenti ai loro oggetti di business più strettamente (nella maggior parte dei casi).

E mai e poi usi una particolare convenzione di codifica solo per soddisfare il tuo ambiente di programmazione (ad es. completamento del codice in Visual Studio o Eclipse).

Per quello che vale, i due fattori a cui attribuisco il maggior valore quando si assegnano nomi alle variabili (oltre al significato, ovviamente) sono

• È leggibile, cioè quanto è probabile che io possa leggerlo in modo errato o accidentalmente sceglierlo da un elenco Intellisense?
• Come suona quando viene pronunciato? Posso parlare delle mie variabili senza confondermi, rimanere legato alla lingua o sembrare un libro del Dr. Suess?

Quindi, per questi motivi, AdjustedArea è migliore di AreaAdjusted (sembra solo più naturale) SurfaceAreaInner e SurfaceAreaOuter sono molto meglio di SurfaceInnerSurface e AreaOuterSurface (dove il qualificatore è in realtà nascosto nel mezzo del nome), ma in realtà preferisco InnerSurfaceArea e OuterSurfaceArea, poiché è così che mi riferirei a queste cose se fossi un civile, quindi per parlare, e non uno sviluppatore.

Non penso che ci sia una risposta giusta a questa domanda. In realtà, confina con una questione religiosa;).

Sia modificatore soggetto che soggetto-modificatore hanno merito e svantaggi. Alcuni di questi non sono inerenti ai nomi delle variabili stessi, ma agli strumenti utilizzati per creare e mantenere il codice (tale nome assiste usando solo starts-with).

A volte, l'unica differenza tra i due può essere il tuo punto di riferimento. Ad esempio wallThickness, se sto lavorando con vari spessori, wall è il modificatore. Se guardo i muri, lo spessore è il modificatore.

Probabilmente la migliore risposta è adattarsi al tuo codice esistente. Fare altrimenti significherebbe che gli altri membri del team sarebbero sorpresi dalle scelte del tuo nome. Ciò porterà alla duplicazione del calcolo e ad un generale peggioramento della velocità di codifica e manutenzione.

In uno standard di codifica, potrei esprimere una raccomandazione per preferire l'uno rispetto all'altro, ma vorrei che non rendesse una regola dura e veloce. Mi piacerebbe che i programmatori facessero la scelta migliore in ogni circostanza particolare.

Preferisco il soggetto modificatore perché è così che solitamente viene scritto e parlato l'inglese.

Se c'è un chiaro vantaggio specifico in una certa situazione per fare un modificatore soggetto-nome, lo farò.