Mantıksal seçenek ayrılmış bir anahtar kelime olduğunda bir şeyi nasıl adlandırırsınız? [kapalı]

Bazen, bir şeyin en mantıklı adı (örneğin bir değişken), tercih edilen dilde veya ortamda ayrılmış bir anahtar kelimedir. Eşit derecede uygun eşanlamlı olmadığında, biri nasıl adlandırılır?

Bu problem için en iyi pratik sezgisel tarama olduğunu düşünüyorum. Bunlar, programlama dilleri ve ortamlarının yaratıcıları veya yöneticileri tarafından sağlanabilir. Örneğin, python.org (veya Guido van Rossum), Python'da bununla nasıl başa çıkılacağını söylerse, bu benim kitabımda iyi bir rehber olacaktır. C # ile nasıl başa çıkılacağına dair bir MSDN bağlantısı da iyi olurdu.
Alternatif olarak, yazılım mühendisliği alanındaki ana etkenler tarafından sağlanan kurallar da değerli olmalıdır. Belki Google / Alfabe bize bununla nasıl başa çıkacağımızı öğreten hoş bir stil rehberine sahiptir

İşte sadece bir örnek: C # dilinde, "varsayılan" ayrılmış bir anahtar kelimedir. Bir enum kullandığımda, varsayılan değeri "varsayılan" ("anahtar" ifadelerine benzer) olarak adlandırmak isteyebilirim, ancak yapamıyorum.
(C # büyük / küçük harfe duyarlıdır ve enum sabitleri büyük harfle yazılmalıdır, bu nedenle "Varsayılan" burada açık bir seçimdir, ancak şu anki stil rehberimizin tüm enum sabitlerinin küçük harf olacağını belirttiğini varsayalım.)
"Defaultus" kelimesini düşünebiliriz. ", ama bu En Az Şaşkınlık Prensibi'ne uymuyor . Ayrıca "standart" ve "ilk" i düşünmeliyiz, ancak ne yazık ki "varsayılan", bu durumda amacını tam olarak ileten bir kelimedir.

Bir enum seçeneği için "title" harfini kullanmalısınız Default. C # büyük / küçük harfe duyarlı olduğundan, ayrılmış anahtar kelimeyle çarpışmaz. Net Adlandırma Kuralları bölümüne bakınız .

Tüm genel üyeler .net'te unvanlı olması ve ayrılmış tüm isimler küçük harf olması nedeniyle, yerel değişkenler (parametreler dahil) dışında bununla gerçekten karşılaşmamalısınız. Yerli halklar genellikle isimler veya isimler olarak adlandırılırlardı, bu yüzden en doğal olanın bir anahtar kelimeyle çarpışması oldukça nadirdir. Örneğin. defaultValuegenellikle daha doğal bir isim olurdu default. Yani pratikte bu büyük bir sorun değil.

C # 'da, @ayrılmış anahtar kelimelerden kaçmak için " " önekini kullanabilirsiniz, böylece bunlar tanımlayıcılar (benzeri @default) olarak kullanılabilirler . Ancak bu, yalnızca gerçekten başka bir seçeneğiniz yoksa, yani tanımlayıcı olarak ayrılmış bir anahtar kelimeleri kullanan bir üçüncü taraf kütüphanesiyle etkileşime giriyorsanız kullanılmalıdır.

Elbette diğer dillerin farklı sözdizimleri ve anahtar kelimeleri var ve bu nedenle de bu problemin farklı çözümleri var.

SQL oldukça fazla sayıda anahtar kelimeye sahiptir, ancak sadece tanımlayıcılardan kaçmak çok yaygındır [Table]. Hatta bazıları, bir anahtar kelimeyle çakışıp çarpışmadıklarına bakılmaksızın, tüm tanımlayıcılar için bile bunu yapar. (Sonuçta, gelecekte bir çarpışma anahtar kelimesi tanıtılabilir!)

Powershell (ve diğer birçok komut dosyası dili), tüm değişkenleri $ gibi bir sigil ile öneklendirir; bu, anahtar kelimelerle asla çarpışmayacakları anlamına gelir.

Lisp’in hiç bir şekilde anahtar kelimeleri yoktur, en azından geleneksel anlamda değildir.

Python'un PEP-8'de resmi olarak tanınan bir sözleşmesi var :

Her zaman sınıf yöntemlerine ilk argüman için cls kullanın.

Bir işlev bağımsız değişkeninin adı ayrılmış bir anahtar kelimeyle çakışırsa, genellikle bir kısaltma veya yazım bozulması kullanmak yerine tek bir izleyen alt çizgi eklemek daha iyidir. Böylece class_ clss'den daha iyidir. (Belki de daha iyisi eş anlamlı kullanarak bu tür çatışmalardan kaçınmaktır.)

Brainfuck veya Whitespace gibi bazı diller kelimeleri tanımlamaktan kaçınır ve problemi zarif bir şekilde engeller.

Kısacası, sorunuza dilden bağımsız bir cevap yoktur, çünkü bu, belirli bir dilin sözdizimine ve kurallarına bağlıdır.

Bir alt çizgi eklerdim (default_)

Artıları:

• basit
• açık (neden başka bir alt çizgi eklesin?)
• tutarlı, istikrarlı
• kullanımı kolay
• bildiğim tüm modern dillerde çalışıyor
• mantıksal seçeneğe en yakın

Neden diğer çözümleri sevmiyorum:

Eşanlamlı sözcük:

• bulması zor
• genellikle aynı anlamı değil (nüanslar)

Kelime Ekleme / Hazırlama:

• tutarsız (defaultValue, defaultItem)
• artan okunabilirlik olmadan artan ayrıntı

Harfleri değiştirme (sınıf yerine clazz):

• tutarsız (clazz, klass, klazz)

Bir numara ekleme (varsayılan1):

• default2 sorusunu gündeme getiriyor

Mektup Ekleme / Hazırlama:

• açık değil (programcının isim kodlaması için kullanıldığını tahmin etmesi gerekir, başka bir şey için kısayol değil)

Anahtar Kelimeden Çıkma (@default (c #), `default` (scala))

• sadece bazı dillerde mümkündür
• nadiren kullanılan özellik, özellikle diğer dillerle uyumluluk için
• api'nizin kullanıcıları için kullanımını zorlaştırır (nasıl yapacaklarını ve nasıl yapılacağını bilmeleri gerekir)

Ne zaman kullanmayacağım:

• Mevcut, yaygın olarak kullanılan diğer kongre
• Ben zaten uygun bir eş anlamlı biliyorum
• Enum durumunuzda @ JacquesB cevap izlerdim

"Varsayılan" muhtemelen yararlı bir enum değeri değildir. Kullanıldığı içeriğe bağlı olarak değişebilecek bir davranışı temsil eder.

Diliniz büyük / küçük harf duyarlıysa, o zaman kelime için farklı bir harf kullanın. (Varsayılan vs varsayılan)

Veya daha iyisi, birkaç harf daha yazmak için fazladan çaba gösterin ve buna DefaultValue adını verin.

Adlandırma kurallarını yerel olarak değiştirmemenizi (veya anlamsız karakterler eklememenizi) (diğer mesajlarda belirtildiği gibi) kesinlikle tavsiye ederim. Eğer niyet belli değilse ve neden bu şekilde adlandırıldığına dair sorular sorabilir. Onsuz çözülebilir.

Her durumda, eş anlamlı anlamdaki bir kelimeyi kullanmak veya ismi daha belirgin (veya hatta ayrıntılı) yapmak mümkün olmalıdır. Bağlamın tekrarını getirse bile daha iyi bir çözüm olabilir.

Örneğin, Modedurumunuzda olduğu gibi varsayılan bir değeri göstermesi gereken bir numaralandırma olduğunu varsayalım . Adlandırma default_mode, tekrarlama nedeniyle en iyi görünmeyebilir, ancak istenen anlamı iletirken belirsizliği önler.

Açık veya net bir şekilde farklı ya da değiştirilmiş kelimeler kullanmanız gerekecektir.
Yani bu genellikle ya demektir

• tamamen farklı bir kelime
• önek
• sonek

Belirlenecek diğer bir faktör, birden fazla kelimenin nasıl birleştirileceği ve seçeneklerin genellikle

• allonewordnoseparators
• words_with_underscores-or- dashes ( snake_case )
• CapitalizationForClarityAndReadability ( CamelCase )

Önerim bir önek veya sonek kullanmak ve örneğin alt çizgiler / kısa çizgiler kullanmaktır.

local_default, my_default, a_default, domain_specific_default
default_local, default_me, default_a, default_domain_specific

local_defaultTüm yerlilerin hizalı olması ve bu nedenle hızlı bir şekilde öne çıkması avantajına sahiptir, ancak benzersiz bir ad almak için her zaman ikinci bölüme okumanız dezavantajıdır. default_localbenzersiz değişken adının hızlı bir şekilde görülmesi, ancak yerlilerin görsel olarak her zaman bu kadar kolay gruplandırılmaması konusundaki avantajına sahiptir.

Domain_specific yaklaşımı için gördüğüm birkaç örnek şöyle: vehicle_modelbunun yerine modelayrılmış bir kelime; room_tableBir SQL tablosu tableiçin ayrılmış bir kelimedir.

Dilleri veya komut dosyalarını kullandığım diğer iki seçenek şunlardır:

• değişken adlarını çevrelemek ve böylece ayrılmış kelimelerin kullanılmasına izin vermek için tırnak işaretleri veya ipuçları. Buna benzer bir şekilde bazı dillerin bir geri adım gibi özel bir karakterin bir addan kaçmasına izin verebileceğini hayal edebiliyorum.
• değişken isimlerindeki boşluklar.

Açıkçası, bu durumdan kaçınmak için elinizden geleni yapın. 1970'lerin sonlarından beri yazılımlar yazıyorum ve gerçekten, gerçekten ayrılmış bir kelimeyi atlatmak zorunda kaldığım zamanlar, muhtemelen beşte beşin altında, onun altında.

İlk veya son harfi ( reservedd) iki katına çıkarmak veya öncü veya sondaki alt çizgiyi ( reserved_) eklemek gibi yapabileceğiniz birçok şey var . Uygun olan, özellikle lider veya izleyen alt çizgiler için yazdığınız dilin sözleşmelerine büyük ölçüde bağlı olacaktır. Ayrıca, insanlar tarafından yanlış okunabilecek durumlarla da şeyler yapmamaya çalışın (örneğin, Reservedfarklı olduğunda kullanın reserved).

Bir şey seçtikten sonra, kodlama kurallarınıza koyun, insanların bunu bildiğinden ve sürekli kullanıldığından emin olun. Hatırlatıcı yorum eklemek için o kadar ileri gittim ki okuyucular bir yazım hatası olduğunu düşünmüyorlar ve tekrar göreceklerini biliyorlar:

int ccase;  // Name dodges a reserved word

C # 'da, @ ile bir tanımlayıcının adını hazırlayabilirsiniz . Bu, derleyiciye adı olası bir anahtar kelime olarak değil bir tanımlayıcı adı olarak davranmasını söyler.

enum @default {Sat, Sun, Mon, Tue, Wed, Thu, Fri};