İşlevsel dillerde farklı yorum yapılmalı mı? [kapalı]

Fonksiyonel programlamaya yeni başlıyorum ve kodumu yorumlamanın doğru yolunu merak ediyorum.

Kısa bir fonksiyonu yorumlamak biraz gereksiz görünüyor çünkü adlar ve imza zaten bilmeniz gereken her şeyi size söylemeli. Daha büyük fonksiyonların yorumlanması, genellikle daha küçük kendi kendini tanımlayan fonksiyonlardan oluştuğundan, biraz gereksiz görünmektedir.

İşlevsel bir programı yorumlamanın doğru yolu nedir? Yinelemeli programlamadakiyle aynı yaklaşımı kullanmalı mıyım?

İşlev adı ne yaptığınızı söylemelidir .

Uygulama size nasıl yaptığınızı söyleyecektir .

Bunu neden yaptığınızı açıklamak için yorumları kullanın .

Orada kesinlikle bir fonksiyonel programlar genellikle zorunlu olanlardan daha farklı bir soyutlama düzeyinde olduğu gibi bu soruya bir nokta.

Bu nedenle, başka bir dokümantasyon tarzı gerekmektedir. Yinelemeli programlarda, bir yorum aşağıdaki koddaki gibi yardımcı olabilir, çünkü kodun özü kazan plakasının arkasına gizlenmiştir:

// map 'toUpperCase' over 'container' yielding 'result'
Container result = new Container();
for (int i=0; i < container.size(); i++) { 
             result.addToTail(container.atElement(i).toUpperCase());
}

Ancak bu, işlevsel bir dilde açıkça saçmalıktır:

-- map 'toUpperCase' over 'list'
let result = map toUpperCase list

Daha iyi:

-- we need the FooBars in all uppercase for the Frobnitz-Interface
let result = map toUpperCase list

Bir işlevi belgelememizin nedeni, okuyucuların işlevin gövdesini istememesi veya okumamasıdır. Bu sebeple, büyük fonksiyonlar, işlevsel dillerde bile belgelenmelidir. Uygulamanın ne olduğuna bakarak fonksiyonun ne yaptığını anlamak kolay değil.

Fonksiyon adı ve parametre adları tek başına sözleşmeyi belirtmek için yeterli değilse, işlevler yorumlanmalıdır .

// returns a list of Employees    <-- not necessary
def GetEmployeeList: ...

// returns a list of Employees sorted by last name    <-- necessary
def GetEmployeeList: ...

Kısaca, sözleşme, fonksiyonun neyi beklediğini ve neyi garanti ettiğini tanımlar. Kesin konuşursak, GetEmployeeListsıralı bir liste döndürür , ancak işlev adı veya yorumda böyle bir şey söylemezse, bu işlevin bir tüketicisi bu davranışa güvenmemelidir. Belgelenmemiş bir uygulama detayı ve yazarı GetEmployeeListbu davranışı istediği zaman değiştirme özgürlüğüne sahip.

Yorum kendisi içermemelidir alternatif açıklamanın ziyade bir açıklamasını yapınız (aslında kodunun kendisi salgılanması gibi) kodu ne, ama nedenlerden kodu bu haliyle yazılır neden.

Ben bir yorum için bir neden görmüyorum, dedi kendi başına işlevsel bir dilde farklı olabilir.

Tüm kodumu belgelemek için aynı yaklaşımı kullanıyorum:

• Açıklayıcı isimler kullanın,
• Karmaşık bir mantıktan kaçınılması mümkün değilse, makul bir karmaşık mantığa önce yorumlar ekleyin,
• Tüm sisteme genel bir bakış yazın,

Ad ve tür imzası, işlevin tam olarak ne yaptığını size söylemezse, genellikle yanlış yaparsınız.

25 yaşındayken olayları daha iyi hatırlama eğilimindesiniz. Yaşlandıkça ve eski kodlu birden fazla sistemle uğraşırsanız (evet, bugün yazdığınız kod 10-15 yıl içerisinde eski kod olacaktır), yorum varsa çok yararlı olabilir.