İletişim bilgilerimizi kaynak kodunda bırakmalı mıyız?

Birisi bana daha sonra bir soru sormak isterse, genellikle e-posta adresimi nezaket olarak bırakarım. Diğer insanlar bundan daha fazla veya daha az bilgi mi bırakıyor? Herkes bir telefon numarası bırakır mı?

Neredeyse asla adımı veya e-posta adresimi bırakmıyorum:

• Kopyala yapıştırılma eğilimindedir (evet, kötü uygulama) ; ve ben yazmadım kod için benimle temasa insanlar
• Kod değiştirildiğinde, kişi bilgileri kaldırılmaz veya güncellenmez; ve ben bile onu tanımıyorum bile çok değişti kod hakkında benimle temas insanlar sonunda.

Bunun yerine, insanları kod deposuna (SVN, Git, ...) işaret etmeyi tercih ediyorum : orada, tam geçmişe sahip olabilirler ve hakkında soruları olan kısmı kimin yazdığını / değiştirdiğini öğrenirler.

Bir revizyon numarası ve değişikliğin kısa bir açıklaması ile adımı veya adının baş harflerini yorum başlıklarında bırakma alışkanlığı içindeyim.

Ben bu sürüm kontrolü ile gereksiz olduğu göz önüne alındığında son zamanlarda bu alışkanlık çıktım, örneğin, hangi değişiklikleri yapan herhangi bir kimse sürüm kontrolü kaynak kodun tüm geçmişini görebilirsiniz görebilirsiniz.

Profesyonel olarak yazılım geliştiriyorsanız, büyük olasılıkla bazı sürüm kontrol sistemi (svn, hg, git, vb.) Kullanıyorsunuzdur. Bu durumda, projede kod işleyebilmek için zaten bir kodlayıcı hesabınız (bu bilgilerle) bulunduğundan kişisel bilgilerinizi kodun içinde bırakmanız gereksizdir.

Bununla birlikte, açık kaynak topluluğundan bazı kişiler iletişim için bir ad ve e-posta adresi bırakmayı ilginç buluyor. Bu hiç de fena bir fikir değil. Bu örnekleri kontrol edin:

FFmpeg'den:

/*
 * Interplay C93 video decoder
 * Copyright (c) 2007 Anssi Hannula <anssi.hannula@gmail.com>
 *
 * This file is part of FFmpeg.
 */

DirectFB'den:

/*
   (c) Copyright 2001-2009  The world wide DirectFB Open Source Community (directfb.org)
   (c) Copyright 2000-2004  Convergence (integrated media) GmbH

   All rights reserved.

   Written by Denis Oliver Kropp <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de>,
              Sven Neumann <neo@directfb.org>,
              Ville Syrjälä <syrjala@sci.fi> and
              Claudio Ciccani <klan@users.sf.net>.
*/

Ama kesinlikle adımı ve / veya e-posta bırakarak koduma yorum yazmak gerekiyordu anlamına gelir ?? Üzgünüm bir cevap değildi. Gerçekte ben genellikle doctype yorumları bırakıyorum ...

/**
* @author PurplePilot
* @package
* @etc
*/

adımla değil e-posta adresimle Evet, bu kod kesilip yapıştırılabilir, ancak fotokopi makinesi yazar adını değiştirmezse, başka bir şey değiştirmeyecek ve korunmayan bir yorum olduğu ortaya çıkacaktır.

Zaman zaman kullandığım bir e-posta sig var

/* Anything you put in comments is not tested and easily goes out of date. */

bu konudaki diğer yazıların çoğunun genel bir yansıması gibi görünüyor. Ancak konuyla ilgili kurallar olmadığından, bir programcının en rahat hissettiklerini yapması gerekir.

Baş harflerini sık sık yorumlarda bırakıyorum (uygun olan yerlerde), ancak daha fazla bir şey bırakmak için herhangi bir neden göremiyorum. Hala kodun sahibi olan şirkette çalışıyorsam, insanlar benimle nasıl iletişim kuracaklarını bilmelidir.

Eğer şirketten ayrıldım ve başka bir yerde çalışsaydım, son şirketimde (kim rakip olabilir!) Yazılım hakkında çağrı alırsam, yeni işverenime pek adil gelmez.

Kod başka bir şekilde paylaşıldıysa (örneğin, açık kaynaklı, çevrimiçi olarak yayınlandı), iletişim bilgilerinizin olması muhtemelen faydalıdır, ancak kod başka bir şekilde iletildiyse, verdiğiniz kişi büyük olasılıkla iletişim bilgileri, ve gerçekten yıllar önce yazdığınız kod hakkında soran rastgele bir yabancı ister misiniz?

Şunu söyleyen bir düşünce vardır: Kaynak kontrolünde olması gereken kaynak kodunu yazmayın.

Yazarlık bilgileri bu şeylerden biridir, çünkü zaman içinde kod, dosya ayrıntısından daha az sayıda kişi tarafından değiştirilecektir. Suç günlüğü size bilmeniz gereken her şeyi söylemelidir.

Bununla birlikte, birçok şirket orijinal dosya yazarını listeleme geçişini takip eder ve asla değiştirmez. Gerçekten yararlı olsun (insanlar şirketten ayrılırken), bilmiyorum.

Asıl değerin farkındalık yaratmak olduğundan şüpheleniyorum. Gidip IDE'den size gördüğünüz her dosyayı kimin yazdığını söylemesini istemezsiniz, ancak bunlarla zaman içinde grubunuzun kod tabanında karşılaştığınızda, projedeki sorumluluklar ve uzmanlık hakkında fikir sahibi olursunuz.

Kamu malı için - fayda "reklamcılık", olumsuz tarafı, birinin gelecekte dosyanızı enkaz haline getirebileceği, ancak yine de adınızı taşıyacağıdır.

3 yıllık programlama, bakım ve dönüştürme yazılımlarından sonra, kaynak koddaki yazar bilgilerinin değersiz olduğunu rahatlıkla söyleyebilirim.

Bunu hiç kullanmadım. Güvenilir olamaz. İnsanların hiçbiri hala şirket tarafından istihdam edilmiyor. İsimlerin yarısı yüklenicilerdir.

İletişim bilgilerimi asla kodda bırakmam. Her zaman güncelliğini yitirir ve çözdüğünden sonra daha fazla soruna neden olduğu görülmektedir.

Diğer insanlar problemlerden birkaçına dikkat çekti, ancak en sinsi etkiler olduğunu düşündüğüm birinden bahsetmek istedim.

Ekip çalışmasını ve kod kalitesini yok edebilir.

Nasıl sorabilirsiniz, her şey kolektif kod sahipliği ile ilgili. Eğer kod isminizi koyarsanız, bir sonraki kişi "bu benim kodum değil, sadece X" diyecektir, burada X kesmek, görmezden gelmek vb. elbette isimlerini koda koymak isterler çünkü geliştirdiler. Ama sonra düşünebilirsin, hey bu kod için haftalar geçirdim ve 10 dakika geçirdiler, neden isimlerini doğru benimkine aldılar? Zamanla bu döngü devam eder ve insanlar kod için kimlerin kredi alması gerektiğini (veya suçlamayı) tartışırlar.

Sadece takım için iyi sonuç vermez. Bunun yerine, ekip kolektif mülkiyete odaklanmışsa ve tüm kodu mülkiyeti olmadan harika hale getirirse, sistemin kalitesi olan gerçekten önemli olana odaklanabilirsiniz. Üzerinde kimin çalıştığını bulmanız gerekiyorsa, ayrıntıları almak için her zaman VCS'yi kullanabilirsiniz.

Not: Bir geliştirici adına sahipse, özellikle geliştirici diğer katkıda bulunanlar kadar etkin değilse, telif hakkı başlıkları bile bu yıkıcı etkiye sahip olabilir. Bu nedenle Açık Kaynak projelerinde yalnızca YAZARLAR'daki bir yazardan veya katkıda bulunanlardan projede bir yer belirtmeye çalışıyorum.

VCS'm benim için hesap verebilirliğe önem verdiği için iletişim bilgilerimi kaynak kodunda bırakma eğiliminde değilim.

Bununla birlikte , kodu kullanan kişilerin geri bildirim sağlamak için doğrudan sizinle iletişim kurabilmesi için iletişim bilgilerinizin bir yere sahip olmanız önerilir . README dosyasındaki bir proje web sitesine bağlantı genellikle iyi bir uygulamadır.

Sözleşme, Usenet ve IRC'nin kaynak kodunu paylaşmak için düzenli olarak kullanıldığı dönemden geliyor. Kod nadiren bir VCS'den bağlandığından ve daha sık doğrudan gönderildiği için, geri bildirim istiyorsanız, iletişim bilgilerinizi bir yere eklemeniz gerekir.

İsmimi SQL komut dosyalarında bırakıyorum, çünkü çoğunlukla kaynak kontrolünden değil doğrudan veritabanından getirilecekler.