"A", "an" e "the" nei nomi di metodi e funzioni: cosa ne pensi? [chiuso]

Sono sicuro che molti di noi hanno visto nomi di metodi come questo in un punto o nell'altro:

• UploadTheFileToTheServerPlease
• CreateATemporaryFile
• WriteTheRecordToTheDatabase
• ResetTheSystemClock

Cioè, nomi di metodi che sono anche frasi inglesi grammaticalmente corrette, e includono parole extra puramente per farle leggere come in prosa. Personalmente, non sono un grande fan di tali nomi di metodi "letterali" e preferisco essere succinto, pur essendo il più chiaro possibile. Per me parole come "a", "an" e "the" sembrano semplicemente imbarazzanti nei nomi dei metodi, e rende i nomi dei metodi inutilmente lunghi senza aggiungere davvero nulla di utile. Preferirei i seguenti nomi di metodo per gli esempi precedenti:

• UploadFileToServer
• CreateTemporaryFile
• WriteOutRecord
• ResetSystemClock

Nella mia esperienza, questo è molto più comune dell'altro approccio di scrivere i nomi più lunghi, ma ho visto entrambi gli stili ed ero curioso di vedere quali erano i pensieri degli altri su questi due approcci.

Quindi, sei nel campo "nomi dei metodi che leggono come in prosa" o "nomi dei metodi che dicono cosa intendo, ma leggi ad alta voce come un brutto campo di traduzione da lingua straniera a inglese"?

Concordo sul fatto che i metodi di prosa fanno schifo con un'eccezione:

Casi di unit test

Questi generalmente non vengono mai chiamati nel tuo codice e vengono visualizzati nei rapporti di prova. Come tale, è utile avere letture con un po 'più di prosa:

• Aggiunta ACustomerOrderFailWhenCustomersIdIsInvalid: non riuscita
• OutOfBoundsPriceReturnsAnError: Passed
• CanDeleteAnEventFromASeason: superato

Anche questo dovrebbe essere fatto con parsimonia, ma posso vederlo come almeno un caso in cui le aggiunte grammaticali possono rendere un po 'più facile esprimere ciò che è passato e ciò che è fallito. Questo ovviamente, a meno che il tuo linguaggio / framework non fornisca un buon meccanismo per le descrizioni dei test nella lettura dei test oltre ai nomi dei metodi, nel qual caso ignora anche questo.

Per parafrasare Lawrence da Office Space ...

No, no, amico, credo che se qualcuno con cui ho lavorato qui avesse chiamato una funzione "UploadTheFileToTheServerPlease", si sarebbe preso a calci, amico.

Tali nomi "lunghi" non sembrano prosa . Quando sono soli, forse, ma accompagnati dal resto del codice, fanno solo più casino. Controlla:

bool ResultOfTheUpload
      = UploadTheFileToTheServerPlease(TheNameOfTheFile, TheServersAddress);

Yuuuuk! ..

Questo non è un testo inglese valido e in nessun linguaggio di programmazione sembrerà uno. Quindi non ha senso spendere byte in articoli.

Dal punto di vista dei programmatori "UploadFileToServer" ha più senso e facilità di lettura e comprensione rispetto a "UploadTheFileToTheServerPlease".

Più della grammatica inglese, la leggibilità e la comprensibilità contano di più nella programmazione!

Dato il numero di errori di battitura della mia vita, finirei

* UploadTehFileToTehServerPleaz
* WriteTehRecordToTehDatabase
* ResetTehSystemClock
* ICanHazTehCheezburger

Scherzi a parte, guarderei anche a come si chiamava la mia classe. Se la mia classe si chiamasse "File", probabilmente andrei semplicemente con

*UploadToServer
*DownloadFromServer

Così sarebbe

   File file = new file;
   file.UploadtoServer(ServerAddress);

Solo un esempio banale, ma speriamo che sia abbastanza illustrativo.

Personalmente non mi interessa. Li ho visti e non mi danno fastidio. Non ci ho nemmeno pensato fino a quando un altro programmatore non si è arrabbiato con loro. Ho trovato scioccante che qualcuno si preoccupasse così tanto di qualcosa che conta così poco. Voglio dire, era davvero arrabbiato per questo. Ma è stato all'inizio della mia carriera, circa 11 anni fa, e da allora ho scoperto che gli sviluppatori arrabbiati per le cose minori sono in realtà abbastanza comuni. Ecco perché i gestori degli sviluppatori vengono pagati così bene. Devono avere a che fare con gli sviluppatori su base giornaliera.

E preferirei vederlo piuttosto che "UL_FlToSrv".