Xiami Music'in "Push VIP" olayından bahsetmişken, programcılar kod yorumları hakkında ne düşünmelidir?
Düzenle Xiaozhi
19 Kasım'da, teknik bir forumda Ali'nin Xiami Music müşterisini tartışan ve netizenler arasında tartışmalara neden olan bir gönderi vardı. Afiş, Xiami Music istemcisinin programcılarının kod yorumlarında bazı kısa vadeli VIP müşterilerini aslında "zayıf" VIP olarak adlandırdığını iddia etti.Ayrıca "Dilenci VIP" gibi benzer yorumlar da var. Birdenbire hararetli tartışmalara neden oldu.
Orijinal posta adresi:
https://www.v2ex.com/t/407653?p=1
20 Kasım'da, Xiami Music App'in sekiz eski çalışanı Zhihu ile ilgili yorumlarını güncelledi, "Herkese özür dilerim, onu başlatan programcıyım. Şu andan itibaren kodu dürüstçe yazacağım ve ciddi bir şekilde yorum yazacağım." Kendini beğenmiş "Tucao" da müşterilere olan saygısını kaybettiğini söyledi ve tüm Xiami kullanıcılarından ve internet kullanıcılarından özür diledi. Ayrıca programcı, ailevi nedenlerden dolayı bir ay önce istifa ettiğini ve bu sefer ne olduğunu düşünmediğini söyledi.
Bağlantıyı bilin:
https://www.zhihu.com/question/68347364/answer/262277195
Aslında, Amerika Birleşik Devletleri'nde olduğu gibi birçok benzer anlaşmazlık var:
Microsoft, "kara liste" ve "beyaz liste" terimlerinin kullanımını tamamen ortadan kaldırdı.
"Kara liste" artık "engelleme listesi" ile değiştirildi
"Beyaz liste", "izin verilenler listesi" veya "onaylanan liste" ile değiştirildi
Değiştirme nedeni:
Bir şirket politikası olarak, "kara liste" (veya "kara liste") terimi, ırk açısından saldırgan olarak araya girilebileceği için Microsoft'ta kullanılmamalıdır.
Şirket politikasına göre, kara liste terimini kullanmıyoruz çünkü bu bir tür ırk ayrımcılığı olarak yorumlanabilir.
Bazı programcılar kod yazmanın uzun ve sıkıcı bir süreç olduğunu düşünüyorlar, kod yorumlarında herhangi bir şikayet ya da eğlence bırakmıyorlar ve on milyonlarca satır kod için üzgünüm. Bu nedenle, komik veya saçma olan her türlü kod açıklaması vardır. gibi:
Kod yorumları gerçekten programcının kişiliğini gösteren bir yerdir, ancak onu bırakırsanız Xiami Music gibi bir halkla ilişkiler krizi yaşamak kolaydır. Yurtiçi ve yurtdışındaki programcılar kod yorumları hakkında ne düşünüyor?
Yorum yazmak çoğu insan için kişisel bir konudur, ancak ben yorum yazmaya çok karşıyım çünkü kod bir kez değiştirildiğinde bu yorumlar güvenli hale gelir - bu durumun çoğunu görüyorum: yorumlar hala oradadır, ancak Kod silindi veya açıklanan davranış silindi, kod yorumun hemen sonrasına gelmiyor (çünkü birisi yorum ile orijinal kod arasına yeni bir kod ekledi), yorum ve kod tutarsız çünkü kod değiştirildi Yorumlar değişmedi. Bence bu tür yorumlar yorum yazmamaktan daha iğrenç. Yorumlardan nefret ediyorum.
Bazen yorumlar hala çok kullanışlıdır, örneğin, tasarımda kaçınılmaz kısıtlamalar (performans değişiklikleri, vb.) Olduğunda, bazı yorumlar ekleyebilirsiniz. Yorum yazmamaya çalışıyorum. Her 10.000'den fazla kod satırında bir yorum yazıyoruz (kişisel olarak yalnızca genel API'ler için yararlı olduğunu düşündüğüm sıkıcı xmldoc yorumları dışında ve başka hiçbir şey için değil). -Kelly Leahy
Daha önce Visual Studio için bir kaynak kodu kontrol paketi yazmıştım. API gerçekten kötü, daha fazla yorum yazmaktan başka bir yol yok, böylece Guid.Empty'nin neden bir yerden ve özel bir GUID'in başka bir yerden geçirilmesi gerektiğini hatırlayabiliyorum (benzer görünüyor). Aksi takdirde her şey alt üst olur. Justin Rudd
Açıkçası kötü olan şey, kodun yorumlanması gerektiğinde yazılmamasıdır. Her şeyden önce, bu dolaylı olarak programcıların akranlarına saygı duymadığını gösterir. Herkes çok sayıda sınıfa bakmanın ne kadar rahatsız edici olduğunu bilir, özellikle de çok sayıda belirsiz ve kötü kendini tanımlayan işlevler içeriyorsa ve daha da fazlası, daha önce kodu yazan kişi tatile gitmiş, işten ayrılmış veya başka nedenlerle Bulamıyorum. Programcı bir sanatçı olmalı ve arkadaşı da seyircidir. Sanatçılar olarak izleyicilerimize saygı duymalıyız.
İkincisi, yorum yazmamak, programcının fazla kibirli olduğunu gösterir. Elbette kod yazarken tam olarak ne yaptığımızı biliyoruz.Programlama yaparken aklımızda pek çok fikir var ama yazdığımız koda bir daha baktığımızda muhtemelen orijinal fikirleri geri alamayacağız. Bunlar ortak şeylerdir ve uygun yerlere açıklayıcı yorumlar yazmamızı gerektirir. Timo Hilden
Temel olarak, kod yorumları nadiren yazılır ve yorum yazma zamanı, iyi bir değişken adı oluşturmak için kullanılır. PrideChung
TODO yazarken, uygulama tamamlandıktan sonra silinen uygulama yöntemini kısaca açıklamak için açıklayıcı notlar yazabilirsiniz. Dorentus
Yorumlar, kodun basit bir tekrarı olmadığı ve iyi bir formatla garanti edildiği sürece, daha fazla yorumun herhangi bir zararı yoktur. Ben sadece bir tür yoruma karşı çıkıyorum, o da gereksiz kodu çerçevelemek. SoloCompany
İşlevler genellikle yorum yazmaz ve kod kendinden açıklamalıdır. Bazen karmaşık mantık yazarken, adımları yazmak için önce yorumları kullanırsınız ve yazmayı bitirdikten sonra onu silmeyeceksiniz ... Diğer kişilerin kodu genellikle hareket etmeyecektir (başkalarının koduyla uğraşmayın), ancak kendi kodunuzu yazdıktan sonra ilk sırada yer alacaksınız. Üçünün karmaşıklığına göre konumu hakkında yorum yapın. (Önceki cümleden farkı, önceki cümlenin başından itibaren karmaşık olmasıdır, ancak burada ne kadar karmaşık yazılırsa, mantık veya iş nedeniyle olabilir) repus911
Bugünün konusu
Kod yorumları hakkında ne düşünüyorsunuz? Hangi ilginç kod yorumlarını yazdınız veya okudunuz?
Bize anlatmak için bir mesaj bırakmaya hoş geldiniz! Yorum alanı yerinde, lütfen performansınıza başlayın!
