Yazarlar referans olarak kodlarına bir bağlantı vermişlerse, özellikle makale koda dayanıyorsa, yorumda bulunmak uygun olur.

Ancak, eleştiriyi yapmanızı tavsiye ederim. yapıcı: Yalnızca "dağınık" veya "özensiz" olduğunu ve "temizlenmesi" gerektiğini söylemek yerine, nasıl iyileştirilebileceğine dair somut öneriler sunun.

Kod inceleme kapsamındadır ve bunu gözden geçirmek ve eksiklikleri ile ilgili yapıcı önerilerde bulunmak uygundur. Şimdi, argümanlarını gözden geçirenleri tatmin etme sorumluluğunun yazara ait olduğunu ve eğer argüman okunamayacak kadar dağınık olan bilgisayar koduna bağlıysa, bunu onlar için düzeltmenin sizin sorumluluğunuzda olmadığını unutmayın. Bu durumda, yapıcı tavsiye, şu anda neden okumanın çok zor olduğunu açıklamakla sınırlı olabilir (yani, girinti eksikliği, belirsiz değişken adları, vb.) Ve bu, makul bir şekilde gözden geçirme ve yeniden gönderme önerisine yol açabilir. Kodun okunmasının neden şu anda zor olduğunu açıklarken açık ve kapsamlı olmaya çalışın, bu nedenle sonraki yeniden gönderimlerin sıfırdan yapılması beklenebilir.

Bu durumlarda yapılacak en iyi şey, bilgisayar kodu tıpkı kağıttaki nesir gibi. Düzyazıda olduğu gibi, bilgisayar kodunun kodlama standartlarına göre açık ve anlaşılır olması gerekir. Dağınık ve anlaşılmazsa, netleşene kadar gözden geçirilmesi gerekir. Hakemler, düz yazı anlaşılmaz olduğunda kağıtları reddetmekten çekinmezler, bu nedenle bilgisayar kodunun anlaşılır hale getirilmesini talep etmek tamamen mantıklıdır.

Evet, yorum yapmalısınız ve muhtemelen daha fazlasını yapmalısınız.

Kendiniz söylediniz:

Makaledeki pek çok sonuç büyük ölçüde bilgisayar hesaplamalarına bağlıdır.

Dolayısıyla, hesaplamalar için program kodu, incelemekte olduğunuz çalışmanın bir parçasıdır. Makalenin metnini okumak zor olsaydı, bunu bir zayıflık olarak görmez miydin? Bu nedenle mantıksal olarak aynısı kod için de geçerlidir (biraz daha az ölçüde olsa bile).

Ayrıca, kod sizin için okunamıyorsa - sağlam matematiğe rağmen kodda hatalar olabilir altında. Son olarak, kod olmadan sonuçların ne olması gerektiğini anlayabiliyorsanız, o zaman neden kodu bile aldınız?

Dolayısıyla, dağınıklığın makaleyi "ayrıştırmayı" engellemediğini düşünüyorsanız, yorum yapın (ve belki de alakalıysa, Güçlü Kabul'den Zayıf Kabul'e düşürün, ancak bu çok sert olabilir - ayrıntılara bağlıdır.)

Kodu çok sonuca göre okumanız gerekiyorsa ve basitçe olamaz, o zaman bu daha ciddi bir sorun. Ancak "Revizyon gerektiriyor" gibi bir şey söylemeden önce dergi editörüne / program komitesi başkanına / vb. Danışın.

_{Not: Ben bir Bilgisayar Bilimcisiyim, bu yüzden cevabım biraz önyargılı olabilir. Öte yandan, kodsuz saf teori makalesi yazdım.}

Dağınık kod yeniden üretilebilirliği etkiler

Sonuçlarını bağlantılı kodla yeniden oluşturmaya çalıştınız ve yapamadınız. Nihayetinde kendi kodunuzu geliştirebileceğinizi ve sonuçları kopyalayabileceğinizi ima ederken, kötü yazılmış kodun yeniden üretilebilirliği etkilediğini iddia ediyorum. Bilgisayar programlamasında, programlama dillerinin mutlaka çok uzun ömürleri olmadığı için bu daha da önemli olabilir. Magma veya başka bir dilin 50 yıl içinde ortak bilgi olup olmayacağını kim bilebilir.

Uzun görüşe göre, tekrarlanabilirlik bilimsel çabanın en önemli parçasıdır. a yapmanın b ile sonuçlandığının kanıtı, denemek isteyen herkes tarafından yeniden kanıtlanabilecek bir gerçek, daha fazla bilimsel sonuçların dayanabileceği aksiyomatik bir yapı taşıdır.

Tekrarlanabilirlik önemliyse, onlara kodlarını temizlemelerini söylemekte yanlış bir şey yoktur. Açıkçası, eğer kodları sizin tarif ettiğiniz kadar kötüyse, yazarlar birkaç yıl içinde ona geri dönerek kendi çalışmalarını anlamakta güçlük çekecekler. Bu durumda, onları güzel kod yazmayı biraz öğrenmeye zorlayarak, onlara bir iyilik yapmış olursunuz.

Mevcut cevaplarda yer almayan bir konuya kısaca değinmeme izin verin.

Sorum şu, yazarlara kodlarının gereksiz yere zor olduğunu söylemem mantıklı mı? anlıyor musunuz ve geliştirilmeli mi?

Evet , kod hakkında yorum yapmalısınız, ancak sadece bu değil: yazarları kendi içlerinde olduğuna ikna edin -bu sorunları çözmek.

Okunabilir kod, yeniden kullanımı kolay koddur. Yeniden kullanılabilir kod, makalede sunulan matematiği keşfetmeyi kolaylaştıran koddur. Keşfedilebilir matematik, ilginç uzantılar bulan okuyucuların olması daha olasıdır. İlginç uzantılar yayınlanır ve bu yayınlar orijinal koddan alıntı yapar ve dahası, etrafındaki en değerli alıntılardan bazılarını sağlar.

Kodunuzu okunabilir ve yeniden kullanılabilir hale getirmek bunun olacağını garanti etmez, ancak Okunamayan kod yayınlayın, çalışmanıza dayalı olarak daha fazla araştırma yapmaya devam edebilecek veya gitmeyebilecek bir okuyucunun önüne yapay bir engel koyuyorsunuz ve bu tür yeterli engeller varsa, o okuyucu başka bir yere dönecektir. Kodu okunabilir hale getirmek, işin genişletilebilirliğinde büyük bir gelişme ile sonuçlanan mütevazı bir zaman yatırımıdır.

Bu engellerin kaldırılması elbette koda özgü değildir: belirsiz figürler, karmaşık yapı, karmaşık dilbilgisi, eksik sözcükler ve diğer her türlü sorun benzer engelleri ortaya çıkarabilir ve bir hakem olarak işiniz, bunları işaret etmeyi ve yazarların onlardan kurtulmasına yardımcı olmayı içerir. Kod farklı değildir - iyileştirmelerine yardımcı olun!

Akademide değilim veya bu düzeydeki makale / makale incelemecisi değilim (teknoloji okulunda yardımcı), ancak çok sayıda programlama ödevine ve garip teknik belge örneğine not veriyorum ve gerçekten ödeme yapmak için yazılım geliştirme yapıyorum faturalar.

Makale, üretilen kodun çıktısına bağlıysa, kod okunabilir ve anlaşılır olmalıdır - aksi takdirde kod, yazarın yaptığını düşündüğü şeyi yapmayabilir ve başkalarının bunu onaylaması imkansızdır. o kendi yeniden uygulamaları. Böyle bir yeniden uygulama nispeten önemsiz ise, o zaman gerçek kod önemli değil gibi görünüyor ve bu nedenle, spesifikasyona dayalı olarak uygulanması kolay bir şey için bozuk kodun neden bilimsel bir makaleye dahil edileceğini veya bunlara atıfta bulunulacağını soruyorum.

Onun algoritmaları için kendi kod uygulamanızı kullanarak doğrulayabildiğinizi düşünürsek, durumun bu olduğunu sanmıyorum, ancak dikkate alınması gerekir. Herhangi bir düzgün IDE veya hatta gelişmiş metin düzenleyici, kodu otomatik olarak biçimlendirebilmeli ve geniş araştırma / değiştirme (yeniden düzenleme) yapabilmelidir. Bir çeşit saf tembelliği işaret ediyor ...

Yazarlar makalede bir bağlantı sağlar, bu nedenle kod ya bir referans ya da araştırmanın bir parçası olarak kabul edilir. Durum ne olursa olsun, bu soruları gündeme getirir:

1. Kod arşivlendi mi? Kodu arşivlemenin pratik yolları arasında Zenodo veya figshare bulunur. Ana sayfadaki kod, hiç kod olmaması kadar iyidir.
2. Kodun lisansı var mı? Değilse, durumu hiç belli olmaz.

Bir yorumcu olarak, ne yapacağınıza karar vermek size kalmıştır. Olası eylemler şunları içerir:

1. Kod hakkında yorum yapmayın.
2. Koda yorum yapmak için benim minimum diyeceğim şey: kodun arşivlenmesi ve uygun şekilde lisanslanması gerekir .
3. Bilgisayar programının araştırmadaki önemine bağlı olarak, minimum miktarda okunabilirlik gerektirmesi ve yazarın program üzerinde bazı testler sağlaması (yani, bazı parametre setleri izin veriyorsa programın bilinen analitik cevaplar vermesi) vb.).

Arşivle ilgili olarak, Journal of Open Research Software 'in editoryal bilgilerine başvurabilirsiniz.

Ben bir yazılım mühendisiyim ve soruyu bu açıdan yanıtlamak istiyorum. Çoğu kod kendi başına okunabilir değildir. Alt rutin aramaları için veri yapılarını ve teknik özellikleri belgelemek için yorum yapmanız gerekir. Akademisyenler yazılım mühendisi değiller ve bu konuda profesyonel bir iş yapmalarını beklemiyorum. Yine de, kesinlikle yazılımın kalitesi hakkında yorum yapmak için. Gerçek koda bakmadan, okunamaz olduğunu söyleyeceğimden emin değilim, çünkü makale (ifadeye göre kodu yeniden üretmek için yeterli) program belgelerinin bir parçası olarak kabul edilmelidir. Program kağıtta olduğu gibi kısa isimler kullanırsa, bu sorun olmaz. Eksik girinti düşük kalitenin bir göstergesi değildir, ancak birçok düzey girinti durumudur. Okumakta zorlandığınızı, ancak kod uzmanı olmadığınızı ve belki de bir yazılım mühendisine baktırdığınızı hissetmenizi öneririm. Bildiğiniz farklı bir beceri seti. Bu, yorumun avantajını ortadan kaldırmalıdır.

Üstüne üstlük: Kodu temizlemede iyi bir iş çıkardım, ancak amaç düzeyinde anlamadım. Farklı bir alandaki bir uzmanın neler yapabileceğine şaşıracaksınız.

Sonuç olarak, kod özü değildir, kodun kalitesi tesadüfi ve kararınızı hiçbir şekilde etkilememelidir.

Anladığım kadarıyla yazarların kodu yayınlanmak üzere göndermemesi, bu nedenle kodun sizin incelemenize tabi olmadığı anlaşılıyor. Yazarlar sadece kodlarına bir bağlantı verirler. Bu bir soruyu akla getiriyor: Başka bir yerde yayınlanan çalışmalarına bir referans vermiş olsalardı, onlara bu çalışmanın iyileştirilmesi gerektiğini söylemeyi düşünür müydünüz? Sonuçlarının geçerliliğinin kodlarının doğruluğuna bağlı olduğu iddia edilebilir, ancak koda erişim sağlamamayı seçebilirler, çünkü "bu hesaplamaların altında yatan matematik yeterince iyi açıklanmıştır ki, sonuçları olmadan yeniden üretmek mümkündür. yazarların kodunu kullanarak ". Bir yorumcu olarak, hesaplamalarının sonuçlarını doğrulama zahmetine girdiniz, böylece görevinizin ötesine geçtiniz, ancak bu, sonuçlarının gerçekten tekrarlanabilir olduğu anlamına geliyor.

Bu nedenle, bundan bahsedebileceğinizi düşünüyorum. kodlarının kötü olduğunu (görünüşte doğru olsa da), ancak bu, makaleyi yayınlama / yayınlamama konusundaki tavsiyenizi etkilememelidir.

Kararlarını koda dayandıran herhangi bir bilimsel dergiden haberdar değilim. Dağınık olup olmaması dergi ile ilgili bir sorun değildir. Yeniden üretilebilir olması bir endişe kaynağı olmalı, ancak bazı topluluklar için bazı girişimler dışında, bunu bir kriter haline getiren herhangi bir dergiden haberdar değilim, örn. NIPS, CVPR. Benim fikrime göre, yayınlamayı seçmeleri zaten bir bonus (ve bazı durumlarda, kuruluşlarının kuralları nedeniyle insanların onları serbest bırakmasına bile izin verilmiyor). Kodun doğru olmadığını veya yaptığı söylenenleri yapmadığını iddia ediyorsanız, bu farklı bir hikaye olabilir, ancak bunu gerekçelendirmeniz gerekir. Yalnızca kodun özensizliği hakkında bir yorum yapmak istiyorsanız, yorumunuzu netleştirmeniz ve genel incelemeyi etkilemediğini vurgulamanız gerektiğini düşünüyorum, daha önce yapılan bir yoruma katılıyorum "yazarları, bu sorunları çözmek için kişisel çıkar. " Sadece kod hakkındaki yorumunuzun makalenin gözden geçirilmesiyle ilgili olmadığını bilin. Ayrıca, lütfen "dağınık" olsa bile kodlarını yayınlayan kişilerin cesaretini kırmayın.