“Komik yorum” kötü bir uygulama mı, değil mi? [kapalı]

Kaynak belgelerine bazı "paskalya yumurtaları" eklenmesinin profesyonel olup olmadığını sormak istiyorum. Muhtemelen okumak zorunda StackOverflow bir kaynak belgelerinde komik yorumlar için anket ve ben şahsen (örneğin kamu API belgelerinde bu zayıf şeyler komik dahil görevim sırasında birçok tür şeyler takıldı (veya değil) var BZZZTT !! 1! Şey Android kamu dokümantasyonunda en az bir düzine örnek daha verebilirim).

Kendim için son bir görüşe gelemem, çünkü kendimle çelişen tartışmalara sahibim.

Pro argümanı:

• Birini neşelendirir ve gününü daha eğlenceli / daha üretken yapabilir. Kaynak kodun büyük bir kısmının yine de yorumlanması gerekmez (eğer proje uygun şekilde yapılırsa), çünkü spesifik yöntem (örneğin) kendi kendini açıklayıcıdır veya garip bir berbat kod yığınıysa, anlamlı bir şekilde açıklanmalıdır, bu yüzden komik bir şaka, dokümanlardan alabileceğiniz olası bilgilere zarar vermez.

Eksileri argümanı:

• Çok konsantre / sinirli iseniz, ihtiyacınız olan son şey birinin aptal şakası, belgelenmiş kod kısmı hakkında ihtiyacınız olan bilgileri vermek yerine, sizi daha da sinirlendirebilir. Herkes böyle yapmaya başlarsa belgelerin nasıl görüneceği fikri de korkunçtur. Ayrıca şakayı yazan adam, okumak için eğlenceli / ilginç / boşa harcanan zamanın değdiğini düşünen tek kişi olabilir.

Ne düşünüyorsun?

Bence komik yorumlar boşa zaman harcıyor - yazmak için boşa harcanıyor, okumak için boşa harcanıyor, iş arkadaşlarınıza göstermek için boşa zaman harcıyor (neredeyse her zaman) sadece kafa karıştırıcı olan komik ifadeyi gösteriyor.

Ama ... hiç kimse aslında her gün% 100 oranında çalışmıyor (eğer böyle yerler boş olsaydı) ve gerçek mizah güne ayrılır ve moralin korunmasına yardımcı olur.

Hâlâ oy verirdim, çünkü şimdiye kadar okuduğum her 'komik' yorum o zamanlar çok komik olabilirdi - ama henüz komik olan, çoğu sadece kafa karıştırıcı veya derinlemesine olan bir tane görmedim. -şaka.

Komik yorumlar gerçekten komik olsaydı fikrimi değiştirirdi. Ancak bir kez şakaları teşvik ettiğinizde, küfretmeyi, hakaret veya kötü niyetli davranmayı teşvik ediyor musunuz?

Ben komik yorumların büyük hayranıyım .

Yorumunuzda daima profesyonel olmalısınız, ancak bazı mizah okuyucuyu öldürmez.

Özellikle okuyucu ekibinizin bir üyesiyse.

En çok sevmediğim şey, kendilerini çok ciddiye alan geliştiriciler. Bence işte eğlenmeliyiz yoksa iş buna değmez.

Eğer bir anlamı varsa, komik olmak iyidir. Bir yorumdaki bir şeyi eğlenceli bir şekilde açıklamak iyidir. Ancak, yalnızca komik bir şeyse ve yorum olarak gerçek bir değer içermiyorsa, bu sadece can sıkıcı bir durumdur . Her zaman yorumların sebebinin bakımı daha verimli hale getirmek olduğunu unutmayın. Mizah bununla çelişmek zorunda değildir, ancak uygun şekilde yapılmazsa yapabilir.

Kod okumak için ... birçok kez içindir.

Yüzlerce anlatımdan sonra bunun kaç tane komik olduğunu biliyorsunuz?

Komik yorumlar harika.

• Görünüşe göre sıkıcı kod için olumlu bir vibe verir.
• Zamanlamanızı doğru yaparsanız . Normal bir sıkıcı yorumdan çok daha iyi açıklar. Burada “zamanlama” derken, yorumun altındaki kodla ilgiliyim demek istiyorum.
• Kodunuz birçok kişi tarafından hatırlanacaktır çünkü duygulara (insan) hafızada daha iyi bir yer verilir. Açık kaynak kodlu bir projede sizinle birlikte daha fazla erkek çalışmasını istiyorsanız, bu harika bir numaradır.
• Genel olarak incelemelerde yardımcı olur. Kodunuzu çok daha katlanılabilir hale getirir. Elbette önce iyi kod yazmaya yoğunlaşmalısınız. Birinin yazdığı koddan emin olduğu zaman komik yorumlar yanlıştır.

Sadece bu adam gibi komik olma ;)

İşte sabah ikide yazdığım bir tane ("DQ" şirketimin ilk harfleridir):

// Twas the night before go-live and all through DQ
// the devs were all crying and yes, this means you.
// Keys had been saved with both hyphens and 'scores
// which left this programmer with finger pad sores.
// The solution I crafted, you'll likely find lacking:
// to OR them together with judicuous hacking.

$hyphenated = str_replace('_','-',$data_type_key);
$underscored = str_replace('-','_',$data_type_key);
// (and then see line 46)

Kaynak kodunuzu müşterinin önünde inceliyor olsaydınız utanır mıydınız?

Mevcut cevapların hiçbiri bunu dikkate almıyor. Bazı müşterilerin mizah anlayışı yoktur ve şakaları işinizi ciddiye almadığınızın bir göstergesi olarak görür. İşinde dikkatsiz olduğun sonucuna varacaklar.

Komik kod yorumları bazen profesyonelce ve uygunsuz olabilir.

Daha önce söylenenlerin ötesinde, eğer uluslararası ekipte çalışıyorsanız, denizaşırı meslektaşlarınızdan bazıları şaka alamayabilir, çünkü ya yerel kültürel referanslar ya da İngilizce'nin anadili olmayan biri tarafından anlaşılmayan bazı sözcüklerin oyunu. . Açık kaynak projeleri için de aynı şey geçerlidir.

Etkili ise ve okuyucuların zamanını boşa harcamazsa (her iki okuma / anlamada) o zaman biraz mizah ile ilgili bir sorun görmüyorum.

Tıpkı gerçek dünyadaki şakalar gibi, eğer her zaman onları yaparsanız komik değil, üretken değil ve profesyonel değil. Ama tüm şakalar için bir zaman ve mekan var ve kodda bir zaman ve mekan var. Tıpkı gerçek dünyada olduğu gibi şakanın nerede, ne zaman ve nasıl yapılacağını bilmek.

Kolejdeki ödevler için, neredeyse her zaman komik yorum yapıyordum, çünkü asla kullanılmayacağını ve sadece bir ev ödevi olduğunu biliyordum.

Daha ciddi projeler için, onları hala burada ve orada kullanırdım, ama o kadar yaygın değil, böylece yorumun amacına karşı gelmek can sıkıcı ya da zor.

Tarayıcı uyumsuzluklarını ve garip aksaklıkları gidermek zorunda kaldığım bir miktar web programlaması yaptığımı hatırlıyorum. Bazen .jsdosyalarda öfke ve nefret dolu yorumlarla sona erdi .

Temel kuralım şudur: Kod bölümünün ne yaptığı biraz açıksa , FUNNY COMMENTS ON!

Eğer kod bu kadar belirsiz ve cehennem kadar karışıksa (" satır içi sınıf " gibi), yorumları kullanmalıyım, birkaç gün içinde kendimi anlayacağım ...