C # İşlev Parametreleri için Hangi Adlandırma Kuralı Kullanılacak

Parametrede iletilen bir adın yeni bir türe dönüştürüleceği durumlar vardır, ancak Passed nesnesinin adı benzer kalmalıdır. Sınıf Öznitelikleri durumunda, bu işleci kullanabiliriz, ancak işlevlerdeki yerel değişkene ne dersiniz. Hangi kodlama kuralı yaygın olarak kullanılmaktadır.

misal,

void MyFunc(BaseClass myPara)
{
  DerivedClass _mypara = (BaseClass)myPara;
}

veya tam tersine

void MyFunc(BaseClass _myPara)
{
  DerivedClass mypara = (BaseClass)_myPara;
}

veya başka herhangi bir sözleşme

Parametreleri veya yerel değişkenleri bir alt çizgi ile öneklemek C # 'da çok deyimsel değildir, okunması çok kolay değildir ve sıklıkla kullanılmaz (yasal olmasına rağmen, dilerseniz ücretsiz yapabilirsiniz).

Parametre ve değişken için en iyi isim açıklayıcı bir isimdir. Türü neden değiştirdiğinizi, dökümün sebebinin ne olduğunu düşünmeniz gerekir. O zaman 2 farklı isim bulmalısın. Örneğin, bir "kişiyi" geçip "müşteri" ye dönüştürdüğünüzde, belki değişken adlarında kişi ve / veya müşteri kullanabilirsiniz.

Eğer gerçekten 2 farklı isim düşünemiyorsanız, o zaman isimde "olarak" kullanırdım ( bu sitede birkaç gün önce bu konuda bir soru vardı ). Örneğin, yerel değişken için "myParaAsDerived" kullanırsınız.

Mümkünse bunu kullanmazsam, çözdüğünüz sorun ve hangi anlamlı isimlerin kullanılabileceği konusunda çok düşünürdüm, ama eğer başka bir şey başarısız olursa, bu oldukça okunabilir.

Öncelikle

void MyFunc(BaseClass _myPara)
{
} 

Açıkça yanlış! Birçok c # kodlama standardı olarak tüm alan adlarında “_” öneki kullanın ! Kod, diğer programcılar tarafından anlaşılması kolay olmalıdır, bu nedenle kod, C # programcılarının birçoğunu yanıltacak şekilde yazılmamalıdır.

Küçük yöntemlerin tüm faydaları göz önüne alındığında, şahsen yerel değişkenleri parametrelerden ayırmak için bir adlandırma kuralına ihtiyaç duymuyorum. Yöntemlerinizde çok sayıda parametre ve yerel değişken varsa, bir adlandırma kuralı olmadan neler olduğunu anlatamazsınız, daha büyük sorunlarınız vardır. (Bu temiz bir Java kitap, bir Java kitap kaplıdır ama yine de bir C # programcı olarak büyük yarar buldum)

Onları bir şeyle önek istiyorsanız, p_parametre için kullanmalısınız : Genel olarak, bunu yaparsanız muhtemelen bir çok insanı rahatsız edersiniz. AMA tutarlı olun, sadece aynı yerde vermek istediğiniz değişkenler için iki farklı isme ihtiyacınız olduğu için bunu tek bir yerde yapmayın.

Değişken adlandırma ile iyi bir genel kural şöyledir;

• Yalnızca bir tür nesne adınız varsa işlevi tarafından adlandırın:

  var builder = new PizzaBuilder();

• İşlevleri ve uzmanlıkları ile birden fazla adınız varsa:

  var pizzaBuilder = new PizzaBuilder();
  var milkShakeBuilder = new MilkShakeBuilder();
  

C # adlandırma kurallarına sahip olacaksınız:

• PascalCasing'i yöntemler, genel özellikler ve sınıf adları için kullanma
• Arabirim adları için IPascalCasing kullanma (başlangıçtaki I öğesine dikkat edin)
• Yöntem parametreleri ve yerel değişkenler için camelCasing kullanma
• Sınıf çapında özel alanlar için _underscoredCamelCasing kullanma

Ve lütfen Macarca gösteriminden uzak durun. Anlamsız ve C # kurallarına uymaz.

Değişken adlandırmada altını çizmek gereksiz olabilir, çünkü özellikle sınıf düzeyindeki değişkenlere atıfta bulunmak için "this" anahtar kelimesine sahibiz. Uzmanlardan gelen değişken adlandırma kuralları hakkında daha fazla bilgi edinmek isterseniz, temiz kodlama akıl hocası Robert C. Martin tarafından desteklenen bir makale olan Tim Ottinger tarafından yazılan "Ottinger'in Değişken ve Sınıf Adlandırma Kuralları" adlı rezil makaleye bakmanızı öneririm. .

Ottinger, kodunuzun iyi yazılmış nesir gibi mümkün olduğunca insanca okunabilir kalması gerektiğini belirtir.

public void Function(string p_Parameter1, string p_Parameter2)

... daha okunaklı olurdu ...

public void Function(string parameter1, string parameter2)

... burada parametre1 ve 2 karşılık gelen değişkenler için açıklayıcı adlardır.

İşte link, kesinlikle bir göz atmaya değer: Link

Parametre ekine inanıyorum: string s_, int i_, etc

Ayrıca parm adlarının mümkün olduğunca kısa ve genel olması gerektiğine inanıyorum.

Şimdi nedenlerden dolayı:

• İşlevde, parametreyi herhangi bir şekilde değiştirmek istemezsiniz, değiştirilmiş bir sürüme ihtiyacınız varsa, onu yapıştırmak için yeni bir değişken oluşturun. Dikkat.
• Bu kuralın istisnaları, parm ref veya out olduğunda ortaya çıkar. Yine de bu son eki kullanıyorum.
• Neden kısa jenerik isimler? Fonksiyonunuzu belgelemelisiniz, böylece s_'nin gerçekten ne olduğunu açıklayıcı anlamda biliyorsunuz. Bu nedenle, benzer işlevlere sahip gruplar oluştururken veya modifikasyon için bir başlangıç ​​noktası olarak başka bir işleve taşımak için bir işlev gövdesini kırpırken kısa jenerikler kullanmak kullanışlı olur.
• Genel adların asıl yararı, çoğu durumda bu parametre adını verdiğiniz şeyi hatırlamak zorunda kalmamanızdır. Bir dize elde etmeyi biliyorsunuz, bu yüzden onun s_, vb ve 'dosyaadı' ya da 'dosyayolu' ya da 'fullpath' olup olmadığını merak etmek zorunda değilsiniz, tek dize yani 's_'.

Her şeyin ödünleşimi vardır ve bir şey kullanıp kullanmamanız, mevcut tarzınıza nasıl uyduğuna bağlıdır.