Yöntem ve işlev adlarında “A”, “an” ve “the”: Almanız nedir? [kapalı]

Birçoğumuzun şu veya bu şekilde yöntem isimlerini gördüğümüzden eminim:

• UploadTheFileToTheServerPlease
• CreateATemporaryFile
• WriteTheRecordToTheDatabase
• ResetTheSystemClock

Yani, dilbilgisi açısından doğru İngilizce cümleler olan ve sadece nesir gibi okunmaları için ekstra kelimeler içeren yöntem adları. Kişisel olarak, bu tür "gerçek" yöntem adlarının çok büyük bir hayranı değilim ve hala mümkün olduğunca net olmakla birlikte özlü olmayı tercih ediyorum. Bana göre, "a", "an" ve "a" gibi kelimeler, yöntem adlarında basitçe garip görünüyor ve yöntem adlarını gereksiz bir şey eklemeden gereksiz yere uzun yapıyor. Önceki örnekler için aşağıdaki yöntem adlarını tercih ederim:

• UploadFileToServer
• CreateTemporaryFile
• WriteOutRecord
• ResetSystemClock

Deneyimlerime göre, bu, daha uzun isimleri yazmanın diğer yaklaşımından çok daha yaygındır, ancak her iki stili de gördüm ve bu iki yaklaşım hakkında diğer insanların düşüncelerinin ne olduğunu merak ettim.

Peki, "nesir gibi okunan yöntem isimleri" kampında veya "ne demek istediğimi söyleyen ama kötü bir yabancı dilden İngilizce'ye çeviri gibi yüksek sesle okunan yöntem" kampında mısınız?

Düzyazı yöntemlerinin bir istisna dışında emildiğine katılıyorum:

Birim Test Kutuları

Bunlar genellikle kodunuzda asla çağrılmaz ve test raporlarında gösterilmez. Bu nedenle, biraz daha düzyazılı okumalara sahip olmak kullanışlı:

• AddacustomerOrderFailWhenCustomersIdIsInvalid: Başarısız
• OutOfBoundsPriceReturnsAnError: Geçti
• CanDeleteAnEventFromASeason: Geçti

Bu bile idareli bir şekilde yapılmalıdır, ancak bunu gramer eklemelerinin neyin geçtiğini ve neyin başarısız olduğunu ifade etmesini biraz daha kolaylaştırabileceği en az bir vaka olarak görebilirim. Bu, elbette, diliniz / çerçeveniz, test okumasındaki yöntem adları dışında test açıklamaları için iyi bir mekanizma sağlamadığı sürece, bu durumda bunu da göz ardı eder.

Lawrence'ı Ofis Alanından yorumlamak için ...

Hayýr, hayýr, adamým, burada çalýţtýđým biri "UploadTheFileToTheServerPlease" iţlevi olarak isimlendirdiđine inanýrsa, bir tekme atýyor.

Böyle "uzun" isimler nesir gibi gelmez . Yalnız olduğunda - belki de, ancak kodun geri kalanıyla birlikte, sadece daha fazla dağınıklık yaparlar. Bunu kontrol et:

bool ResultOfTheUpload
      = UploadTheFileToTheServerPlease(TheNameOfTheFile, TheServersAddress);

Yuuuuk! ..

Bu geçerli bir İngilizce metin değil ve hiçbir programlama dilinde bir dil gibi görünmeyecek. Dolayısıyla, makalelere bayt harcamanın bir anlamı yok.

Programcılar açısından "UploadFileToServer", "UploadTheFileToTheServerPlease" dan daha kolay okunur ve anlaşılır olur.

İngilizce dilbilgisinden daha fazlası, okunabilirlik ve anlaşılabilirlik programlamada daha önemlidir!

Hayatımın kaç yazım hatası olduğu göz önüne alındığında,

* UploadTehFileToTehServerPleaz
* WriteTehRecordToTehDatabase
* ResetTehSystemClock
* ICanHazTehCheezburger

Cidden, sınıf adımın ne olduğuna bile bakardım. Sınıfım "Dosya" olarak adlandırılmış olsaydı, muhtemelen

*UploadToServer
*DownloadFromServer

Yani olurdu

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

Sadece önemsiz bir örnek, ama umarım bu yeterince açıklayıcıdır.

Şahsen umrumda değil. Onları gördüm ve beni rahatsız etmiyorlar. Başka bir programcı onlar hakkında konuşana kadar onları düşünmedim bile. Birinin çok az önemli bir şeye çok fazla önem vereceğini şok edici buldum. Demek istediğim aslında kızgındı. Ama bu kariyerimin başlarında, yaklaşık 11 yıl önce oldu ve o zamandan beri geliştiricilerin küçük şeylere kızgın olmasının aslında oldukça yaygın olduğunu gördüm. Bu yüzden geliştiricilerin yöneticilerine çok iyi ödeme yapılır. Geliştiricilerle günlük olarak uğraşmak zorundalar.

Ve bunu "UL_FlToSrv" yerine görmeyi tercih ederim.