'Matematiksel' işlevler matematiksel gösterimi izlemeli mi?

Sanırım bu soru derhal öznel olarak işaretlenecek, ancak hangisinin daha iyi olduğunu düşünüyorsunuz:

double volume(double pressure, double n_moles, double temperature) {
  return n_moles * BOLTZMANN_CONSTANT * temperature / pressure;
}

veya

double volume(double P, double n, double T) {
  return n*R*T/P;
}

Başka bir deyişle, bazı denklemi uygulayan fonksiyonlar denklemin notasyonunu izlemeli mi yoksa daha ayrıntılı isimler mi kullanmalılar?

Kimin okuduğuna bağlıdır. Tüm sonsuzluk için, kodunuzu okuyan bir sonraki programcının da termodinamiğe aşina olduğunu garanti ederseniz, evet, kesilmiş sürümü tercih edin.

Kişisel tarzım (kısaltmaları alanda yaygın olarak bilinen) bu değişkenleri kullanmak, ancak açıklamalarını açıklamalarına dahil etmektir.

/* P : Pressure
   V : Volume
   n : Number of moles
   R : Boltzmann constant
   T : Temperature (in K)
*/
double compute_V(double P, double n, double T) {
  return n*R*T/P;
}

Sadece dışarı atarak başka bir seçeneğiniz var:

Volume ComputeVolume(Pressure p, Moles m, Temperature t) { ... }

Bu, F # 'ın ölçü birimleri ile yaptığı şeye benzer ve yanlışlıkla bir basıncı bir sıcaklıkla değiştirmek gibi sorunlardan kaçınma avantajına sahiptir. İmza gibi olduğunda (çift, çift, çift) hangi argümanların nereye gitmesi gerektiğini gözlemek zor

Bunu tercih ederim:

/* This function calculates volume using the following formula:
 *
 *     n * R * T
 * v = ---------
 *         P
 */
double volume(double pressure, double n_moles, double temperature) {
    return n_moles * BOLTZMANN_CONSTANT * temperature / pressure;
}

Başka bir deyişle, yorumdaki kodun anlamını İngilizce (ve matematik; yorumlar, gerektiği kadar genişletebilirsiniz) açıklayın, ancak tek kodu okuyan herkesin hala anlayabilmesi için açıklayıcı değişken adları kullanın kolayca - özellikle daha büyük işlevlerle. Değişken adları olarak gerçek kelimeleri kullanmamın başka bir nedeni, işlev bildirimini bir başlık dosyasına kopyalamanız gerektiğinde arabirimin çok daha açık olmasıdır.

IMHO işlev çok etki alanına özgü ise, çalışmakta olduğunuz sorun etki alanının yerleşik gösterimini kullanmak her zaman daha iyidir. Sorunlu etki alanını anlamayan birinin kodunuzu başarıyla koruma şansı yoktur ve etki alanını bilen biri için, uzun adlar sadece gürültü olacak ve sizin için daha fazla yazacaktır.

OTHO, geleneksel matematiksel gösterimin zaman zaman daha ayrıntılı ve açıklayıcı olmasını diliyorum, ancak matematiksel kodun matematiksel kurallara bağlı kalması gerektiğini düşünüyorum.

Düzenleme: Bu cevap yalnızca formülü matematiksel olarak yazarken gösterimde çok güçlü bir kural varsa geçerlidir. Bir tane yoksa ve bir yorumda değişkenlerin neyi temsil ettiğini açıklamak zorunda kalırsanız bile, okuyucunun etki alanına aşina olduğunu varsayarsak, daha açıklayıcı bir sözleşmenin yan tarafında hata yapmak en iyisidir.

Saf görüş, ancak kelimeleri her zaman tek harfli semboller üzerinde kullanın. Eğer kelimeler kullanırsanız, herkes anlayacak; sembol kullanırsanız, sadece konu uzmanlarının takip etmesi garanti edilir. O zaman bile, bazı insanlar aynı fiziksel miktarlar için farklı semboller kullanır. Daha uzun isimleri kullanarak kaybedecek bir şeyiniz yok.

Endişeniz netlikten sonra doğruluk olmalıdır (yanlış ancak net kod kolayca düzeltilebilir), bu nedenle işleviniz mümkün olduğunca genel bir kodlayıcı tarafından sürdürülebilmesi için yazılmalıdır. İşlev başlığı açıklamaları formülü ve kullanımını açıklamalı ve içeri / dışarı parametrelerini açıklamalıdır. Daha sonra, işlev gövdesinin nasıl düzenlendiği, başlık açıklamalarıyla tutarlı olduğu sürece çok fazla önemli olmamalıdır.

(Bunun bir tartışma olmadığını biliyorum ama - kişisel tercihim, değişkenlere açık isimler vermektir, ancak bu durumda bir astar 'saf' bir işlev olarak yeterli olabilir; aynı parametrelere sahip bir çağrı aynı şeyi verir sonuç her zaman açıklama gerektiren devletle ilgili bir karmaşıklık olmamalıdır)

• Boyutsal analizi destekleyen diğer diller, bu C ++ şablonlar ile uygulanabilir, Boost Units kütüphanesi inanıyorum bu yaklaşımı kullanır.

İş katmanından kodun ne kadar "uzak" olduğuna bağlıdır ... Furthur, kod yığınına geri döndüğünde, soyut matematiksel işleve doğru ne kadar hedeflenirse uygular, genel olarak kabul edileni taklit etmeye çalışırım matehmatik gösterim ve adlandırma kuralları .. Ön uç veya iş katmanına ne kadar yakın olursam sorun alanında kurulan sözleşmelere o kadar çok uyurum.

Bunu bu şekilde düşünmeyi seviyorum - Matematikçiler kısa değişkenlerle yanlış anladılar ve fizikçiler de onu takip etti. Hatalarını neden tekrar ettiniz? Artık daha uzun isimlerin daha açıklayıcı olduğunu ve daha az karışıklık ürettiğini biliyoruz, bu yüzden iyileştirmeye sadık kalın. Daha hafif bir notta, bazen matematikte içine daha uzun değişkenler gizlemeye çalışıyorum, herkesin dehşete düştüğü.

Bir programlama denklemi için doğru format, altı ay boyunca görmedikten sonra hala anladığınız formattır.

Geri dönerseniz:

n*R*T/P;

Ve neler olduğunu biliyorsunuz, o zaman muhtemelen iyi. Tipik gelişmiş formüller için ben olmayacağım ben aktif olarak kullanıyorum sürece her parçası olduğunu hatırlıyorum. Benim için:

n_moles * BOLTZMANN_CONSTANT * temperature / pressure;

Denklemin neden olduğu gibi yazıldığını bilmesem bile, her bölümü kolayca anlayabildiğim için çok daha iyi bir denklem biçimidir .

Bozuk parayı at.

Bazen bir değişkenin nasıl adlandırılacağını kodlamanın kendisine harcadığınızdan daha fazla zaman harcıyor musunuz?