Kaynak kodda küfür ile mücadele [kapalı]

İnsanlar kaynak kodunda ve VCS yorumlarında küfürle nasıl başa çıkmaktadır? Sakla veya sil?

Peki ya WTF veya Arrgggh gibi yumuşak patlayıcılar?

Profesyonel olmayan, saldırgan mı yoksa omuz silkilecek bir şey mi?

Yavaşça cesareti kırılmalıdır

... kaynak kodunu 'ömrü boyunca kimin göreceğini muhtemelen bilemezsiniz.

Tamamen işin bir parçası olsa da, özellikle karmaşık ya da eski bir kod parçasından korkmak ve bu konuda ses çıkarmak istemekle birlikte, kaynak koduna patlayıcılar / rants / ASCII sanatı / kötü şakalar / rahatsız edici ifadeler koymak hem profesyonelce hem de tecrübelerime göre kötü bir fikir. Bazen yorumları yazan mühendis, yorumlarının yapabileceği nihai etkilere karşı habersizdir - işte gördüğüm konulardan bazıları:

• Halka açık kod / örnek kod olarak halka açık kodda çok sayıda patlayıcı var.
• Tadı kötü olan şakalar, bazı mahkeme üyelerine endüstriyel mahkemeyle sonuçlanan derin suçlara neden oldu.
• Gerileme, aslında ırkçı / cinsiyetçi / cinsiyetçi olan ve insanların kovulmasına neden olan açıklamalar.

Hepimizin hayal kırıklığı / eğlence / japing için bazı çıkışları olmasına rağmen, kaynak kod bunun yapılacağı yer değil, IMO. Bu belgeler kaynak kodundan daha az okunsa bile, bir Sözleşmeye, Yardım Sayfalarına, Planlara veya diğer profesyonel belgelere patlayıcılar / şakalar / rahatsız edici yorumlar koymazsınız.

Eğer takım liderleri bu konuda çok yardım alırlarsa, üzülecekler, bu yüzden problemli mühendislerle sessiz bir kelime ile 'hafifçe cesaretini kırıyorum' ve bunun Facebook olsun, anında mesajlaşmak için buharı bırakmak için uygun havalandırma mekanizmaları sağladığını söylüyorum , hava hokeyi veya bir yumruk torbası.

Yorumların da derlendiğini söylemek savunma değildir - peki ya JavaScript veya başka bir dinamik müşteri tarafı kodu?

İşte görüşümü şekillendiren gerçek dünya deneyimlerinden bazıları:

• Microsoft'ta çalışırken, bir yazılım mühendisinin "yapamaz" ın doğru yazılışını bilmediğini fark ettim - o, l ve d'yi özlüyor - ve kodunun çoğunu nasıl yapamayacağına dair uzun açıklamalarla karartmıştı. X'in işe yaraması çünkü Y kişisinin Z sorununa neden olması. Kodu çok iyiydi; hecelemesi çok iyi değildi. Söylemek yeterli, bu kodun daha sonraki herhangi bir gözden geçiricisi (örn. Ben) kodda çok sayıda rastgele yemin görmek için alarma geçti. Bu kodun bir kısmı ortaklara gösterilmeye devam edildi (sürücü yazarları). Yeminlerini görmedeki korkularını hayal edin. Hibe makamları, proje yöneticisine sözlü olarak (bu durumda Y kişisi tartışmaya girebilir) ya da mesaj gönderebilir, ancak kaynakta olmamalıdır.

• Bir şirkette, yabancı dil konuşan bir kişi ağırlıklı olarak ingilizce konuşan bir takıma katıldı. Kendi dilinde başka hiç kimsenin okuyamayacağını düşünerek yorum yazdı. Babelfish / Google Translate, dili için bir 'ingilizceye' seçeneği yayınlayana kadar bu iyiydi, bu noktada ekibin geri kalanı birkaç yorumda bulundu ve adamın şirket hakkında yaptığı pis ve sık sık aşağılayıcı yorumlara dehşete düştü. , ekibi ve bir kadın iş arkadaşı. Garip .

• Başka bir şirkette, bir adam gerçekten ASCII sanatıyla çekilmiş ve kod yazarları tarafından tespit edilmemiş (veya belki de kutsanmış) kaynak koduna her türlü sanatı koymuştur. Bir süre sonra bir sebepten ötürü ejderhalar üzerinde dururdu, genellikle bir çeşit etiketle. Daha sonra, bir Galli kişi takıma katıldı. Galler'nin ulusal amblemi kırmızı bir ejderhadır, bu yüzden yeni adam başlangıçta resimlerle ilgili neşeliydi, ama sonra aptalca etiket çizgilerinin bazıları rahatsız edici olarak algılanabilince rencide edildi. Evet, bazı takım lideri arabuluculuğu gerekiyordu ama bu olmamalıydı.

Masumları korumak için isimler / özellikler kaldırıldı.

Kaynak kodunuzu satıyorsanız (örneğin, bir bileşen yazarıysanız), muhtemelen orada olmaması gerekir.

Eğer bu bir ihtiyat meselesiyse, o zaman neyse, bu sana kalmış.

Çok fazla WTF yazan bir yazar görürseniz, belki de onlarla yaşadıkları sorunlar hakkında konuşmanız gerektiğini gösteren bir işaret.

Birisi saldırganlığını başkalarının koduna yönlendiriyorsa, o kişiyi taciz ediyor olabilir ve başa çıkmak için tamamen farklı bir durumunuz olabilir. Belki de yasal bir şikayeti var ve nasıl düzgün konuşulacağını bilmiyorlar. Belki onlar sadece bir pislik.

Bir geliştiricinin yazdığı önemli ne olursa olsun, bir çeşit içerik filtresine sahip olmak akıllıca olmaz ve işlerin nasıl yürüdüğü hakkında size çok şey söyler.

Ben, kendi bünyesinde geliştirilen kodu çalıştıran µControlörleri olan tüketici ürünleri tasarlayan, üreten ve satan bir Fortune 500 şirketi için çalışıyorum. Dava, ya hızlı bir şekilde zenginleşmek isteyen tüketicilerden ya da ihlal talep eden rakipler tarafından her zaman bir olasılıktır. Bu nedenle, kodumuzu ve TÜM yorumlarımızı, bir zamanlar düşman jüri üyeleri tarafından incelenebileceği (muhtemelen olacak) bilgisi ile yazıyoruz. Bu, değişken ve işlev adlarının, gibi teşvik edici terimler içermemesi gerektiği anlamına gelir KILL_CHILD(int process_id). Bu örnek fonksiyonun amacı, çocuk süreçlerini sonlandırmak için iyi olsa da, düşman bir jüri, davacı çocuğunu ürünü kullanırken öldürdüyse, bu fonksiyon adını nasıl görür?

Kod içi yorumlar daha da kötü olabilir. İyi bir savunma ekibi muhtemelen bir çocuk sürecinin ne olduğunu (önceki örnekten) ve neden sonlandırılması gerekebileceğini açıklayabilirken, şöyle bir yoruma karşı savunmak neredeyse imkansız olurdu:

// The following section of code is REALLY BAD!!!  I hope
//  it doesn't burn anybody's house down.

Bunun gibi yanlış yorumlar gerçek mahkeme davalarında belirleyici faktörlerdir.

İlgili bir konuda, yoğun dava mikroskobu altındayken projelerin isimleri de zarar görebilir. 90'lı yılların ortalarında muhafazakar grupların kargaşasını, teknoloji haber kaynaklarının "İnternette SATAN Çıktı" raporunu hatırlıyor musunuz ?

<rant_mode_off>

Tüm bunlarla, kişisel projeler için kodunuzda dilediğinizi yapmakta özgürsünüz.

Seni rahatsız ediyorsa ve sen baş honcho'sun, neden bu konuda bir kural uygulayamadığını anlamıyorum. Sen olan bu varsayımsal bir durumda tüm lideri sonrası.

Ancak, eğer sadece sizi rahatsız ediyorsa ve başka hiç kimsenin umrunda görünmüyorsa, belki onu emmelisiniz.

Sık sık hafif küfür kullandığım için sormam gereken kişi olmayabilir.

Bence bu daha çok PC'nizin (Politik Olarak Doğru) ortamınızın nasıl olduğuna bağlı.

Bir takım-kravat şirketini kodlarsam, küfürü hiç kullanmaya çalışırdım ama hobi bir proje veya başka bir şey içinse aklımı daha özgürce konuşma eğilimindeyim.

Bana öyle geliyor ki, ABD'de ve diğer bazı ülkelerde, insanların yaşadığım ve çalıştığım Hollanda'dan çok daha fazla PC (veya sıkışmış) olduğu görülüyor.

Ek bir bonus olarak, kodda küfür ile ilgili bazı istatistikler: http://andrewvos.com/2011/02/21/amount-of-profanity-in-git-commit-messages-per-programming-language/

Bunun profesyonelce olamayacağına karar vermeye meyilliyim ama herkes zaman zaman küfür ediyor, bu yüzden başkalarına karşı tutmamaya çalışıyorum. Bununla birlikte, kod temeli grubun genel profesyonelliğini yansıtmaya meyillidir; bu nedenle, açıklayıcı yüklü kod temeli, profesyonel olmayan bir grubu yansıtabilir ve gruba "biraz cila uygulamak" için bir toplantı yapılması gerekebilir. Aynı şekilde, kodda belirli eğilimler ortaya çıkarsa, grupta çözülmesi gereken genel sorunların bir göstergesi olabilir (yani, üzerinde çalıştığınız API, geliştirici sorunları olan sorunlara neden olabilir).

Kod temeli açısından, genellikle iş için güvenli olması için ilgili yorumu düzenler ve üzerinde bırakırım. Çalıştığınız dile bağlı olarak, müşteri veya müşterinin önünde neyin görünebileceğini asla bilemeyeceğiniz için bu her zaman iyi bir fikirdir.

Bu profesyonelce mi, saldırgan mı yoksa omuzlarını silkecek bir şey mi?

Muhtemelen üçü ... bakış açınıza göre.

Bazı durumlarda insanların "renkli dili" kullanarak kendilerini ifade etmeleri insan doğasıdır. Bazı kültürlerde diğerlerinden daha çok, bazılarında diğerlerinden daha fazla. Ancak eğilim evrenseldir.

Yerinde olsam, çalışma arkadaşlarınla ​​sevilmeyen biri olmadığın sürece, onu silkiyorum.

Ancak, kaynak kod / VCS yorumları kuruluşunuzun dışında yayınlanırsa, yönetiminiz, işinizin müşterilerinizi rahatsız etmesinin kötü olması temelinde daha güçlü bir yol almak isteyebilir.

Küfürlü sorunlardan biri de kültürden kültüre farklı olmasıdır. ABD'de masum şeyler “kanama” eğilimindeyken, diğer ülkelerde çoğu zaman parlamento tartışmalarında aynı dili dinleyebiliyorsunuz.

Koddaki ve yorum yapan küfür oldukça yaygındır, muhtemelen "kimse görmeyecek" görüşü nedeniyle. Şimdilik çoğu kurumun paskalya yumurtası yasadışı olduğunu düşünüyorum.

Şahsen, müşteriyle yüzleşmeyen şeylerin (iç taahhüt malzemeleri gibi) bir sorun olmadığını düşünüyorum.

Bununla birlikte, çoğu büyük çok uluslu şirket, yasal departmanlar ve “güvenli işyeri” ve bunların hepsi tarafından yönetilmektedir; bu, en az bir kişiye saldırgan olabilecek herhangi bir şeyin, sorun ve işten çıkarma için olası bir neden olduğu anlamına gelir. Kabul etmekten nefret ediyorum ama maaşımı ödeyenlerin düzenlemelerine boyun eğiyorum.

Bu soruna hızlı bir çözüm, kaynak kontrol sisteminize (ön yayın betiği veya düzenli kontrol olarak) bir küfür filtresi kurmaktır.

Sanırım f bombaları oraya atmak gibi kontrolden çıkmadığı sürece sorun değil. Çalıştığım bir erkeğin, her biri temsil ettiği çeşitli nesneleri tartışan iki karakter arasında bir senaryo yazdığını gördüm. Bu iki karakterin 30 satırının birbiri ardında konuşup durduğu çok satırlı bir yorum vardı.

/ * * igor: Kendimi genel maskara mı yapayım? * Frankenstein: ah igor, en iyi özelliklerinden miras alacağım ... * /

Uzun zamandır böyle devam etti. İki nesne yarattı, sen tahmin ettin: Bazı akıl sağlığı kontrolünün bir parçası olarak Frankenstein ve Igor. Aslında çok yaratıcıydı ama tam bir zaman kaybıydı. İki C # nesnesi arasındaki senaryodan çok WTF'ler veya patlayıcılar görmeyi tercih ederdim ...

Şirketin / müşterinin kültürüne bağlı. Örneğin, İncil yazılımı geliştiriyorsanız, herhangi bir biçimde patlayıcı maddeler kesinlikle istenmeyen bir durumdur. Öte yandan, bir oyun geliştiricisi çok fazla umursamayabilir (veya diğer uç noktalara gidebilir).

Her zaman (kodda veya taahhütte bulunan) herhangi bir yorumun yararlı olacağı aklıma gelmez . Bazı kelimeler dikkatimizi diğerlerinden daha fazla çeker - patlayıcı maddeler, yumuşak çeşitlilikte bile kesinlikle fark edilir. Sadece yanlış olan bir şeye dikkat çekmek yararlı olabilir ama henüz bununla ilgili hiçbir yolunuz yok.

Yani, patlayıcı kullanmıyorum ama ara sıra "Doh!" Gibi şeyler kullanacağım. ya da "Huh?" Bu da ruhta çok farklı değil. Eğer sizi rahatsız ediyorsa, suçluyla konuşun - hakkında düşünmeyebilir. Eğer bir zam yapmanızı söylerlerse ve bu konuda kuvvetli bir şekilde hissederseniz, yöneticiye gidin. Yöneticiden destek alamazsanız, onunla yaşamayı veya başka bir yere gitmeyi öğrenmeniz gerekir.

Bunun gibi bir kod hakkında başka ne söyleyeceğinizden tam olarak emin değilim:

tocommit = (n + (COMMITSIZE/PAGESIZE) - 1) & ~(COMMITSIZE/PAGESIZE - 1);

Bu kod, son zamanlarda optimize etmeye çalıştığım gerçek ve oldukça güvenilir bir kod tabanından çıkarıldı. (Kod açık kaynaktır, bu yüzden burada hiçbir işverenin sırrını veya herhangi bir şeyi ifşa etmiyorum.)

Diğerlerinin dediği gibi, işyerine ve kaynak kodunu kimin göreceğine bağlıdır.

Kaynak kodunu satıyor olsaydım, yalnızca yayımlanan sürümlerin ikinci bir deposuna sahip olurdum ve her yeni sürümün sağladıkları bir açıklama dışında, burada herhangi bir check-in yorumuna izin vermem. Günden güne ne yaptığım ve bütün yanlış adımlarım müşterimle değil ekibimle arasında.

Şu anda yapım sunucum OMG, WTF, kludge, mess ve TODO hakkındaki yorumları şu anda kalan temizleme metriği olarak yorumluyor.

Açık kaynaklı yazılımda küfür görüyorsanız ve ondan kurtulmak istiyorsanız, geri gönderme olasılığına hazırlanın. Sadece üç satırlık bir hata raporu yazmayın ve kabul edilmesini bekleyin. Küfür ve ayrımcı dilin neden kötü olduğunu açıklayan bir deneme yazın ve çürütücüleri ön-boşaltın.

Bence kişisel tercih meselesi. Bu şeyler beni gerçekten rahatsız etmiyor, bu yüzden muhtemelen bırakacağım. Sorun alanlarının kodda nerede olduğuna dair bir ipucu bile verebilirim.

Seni rahatsız ediyorlar mı ? Bu soruyu sorduğunuz gerçeğinden, onların yaptıklarını tahmin ediyorum. Bu durumda, bunları kaldırın veya neyin yanlış olduğu hakkında daha uygun yorumlara dönüştürün.