Takım arkadaşlarının bir nesnede hangi değişiklikleri yaptığımı bilmesini nasıl sağlayabilirim? [kapalı]

Bir PHP nesnem olduğunu varsayalım, diyelim ki: companyObj.

class companyObj
{
  private company_name;
  private company_address;

  public function print_contact()
  {
    //logic
  }
}

Bu yazdığım ve takım arkadaşlarıyla paylaştığım nesne. Şimdi bunu daha güçlü hale getirmek istiyorum, şöyle:

class companyObj
{
  private company_name;
  private company_address;
  private company_contact_person;

  public function print_contact()
  {
    //logic updated
  }
}

Şimdi, takım arkadaşlarıma, nesnemin ayarlayabilecekleri daha fazla özelliğe sahip olduğunu nasıl bildirebilirim?

Geliştirme ekibindeki herkese e-posta göndermek yerine, takım arkadaşlarının kaynak kodu düzeyinde nelerin değiştiğine bakmak için zamanlarını boşa harcamasını istemediğimde, ekibin neler olup bittiğini nasıl bilebilirim?

Bu çok somut duruma bağlıdır. Eklediğiniz yeni mülkün zorunlu olduğunu varsayalım, yani her zaman ayarlanması gerekir. Ardından, kodun kendiniz araması ve companyObjdüzgün oluşturulduğundan emin olmak için a'nın oluşturulduğu her yerde güncellemeniz gerekir (yeni özelliğin ayarlanması dahil). PHP, sadece yeni bir yapıcı parametresi eklemeniz gerekir ve derleyici otomatik olarak derleme hatası olarak ekstra parametre olmadan her yapıcı çağrısını işaretleyecek yapıcılar olduğunu varsayalım. Bu aynı zamanda ekip arkadaşlarının a kullandıkları anda yeni mülk hakkında bilgi edinmelerini sağlayacaktır companyObj.

Bununla birlikte, yeni özellik isteğe bağlıysa, işler daha az nettir. Bunun için uygun bir varsayılan değere sahip olabilir veya olmayabilir. İkinci durumda, uygun olduğunda yeni özelliği ayarlamak için tüm örnek oluşturmalarını güncellemenizi öneririm. Bu, kodun her zaman tutarlı bir durumda tutulmasını sağlamak içindir .

Değişikliği ekip arkadaşlarınıza iletmek burada başka bir uzak adım. Çevik ekipler yüz yüze iletişimi ve IMHO'yu iyi bir nedenden dolayı tercih ederler . Belgelere güvenmek, bir ekibin etrafına bilgi yaymanın çok yavaş ve etkisiz bir yoludur . Wiki biraz daha iyidir, ancak yine de her sınıf özniteliğini belgelemek IMHO gereğinden fazladır. Sadece ekip üzerinde büyük bir yük olacak ve yine de güvenilmez ve işe yaramaz hale gelecektir, çünkü biz insanız, bu yüzden bazen güncellemeyi unutmak zorundayız, ayrıca pek çok takım üyesinin düzenli olarak en son kod değişiklikleri hakkında bilgi almak için belgeleri (hangi biçimde olursa olsun) kontrol edin.

İkincisi, örneğin Javadoc veya Doxygen aracılığıyla otomatik olarak oluşturulan belgeler için de geçerlidir. Oluşturulan belgeleri her zaman güncel tutmak için otomatik bir yapıda yapılandırılabilirler, ancak en son kod değişiklikleri hakkında bilgi almak için üyelerin belgelere düzenli olarak göz attığı bir geliştirme ekibi görmedim. Herhangi bir kaynak kontrol sistemi kullanıyorsanız , değişiklikleri fark etmenin ilk yeri , kodun yerel kopyasını yine de güncellediğinizde - o zaman tanıdık sınıflardaki değişiklikleri kontrol edebilir ve neyin ve nasıl değiştiğini (bir ekibinizin anlamlı check-in yorumları eklemeye alışkın olması durumunda kısa bir açıklama ve / veya bir görev kimliğine referans - ki bunlar otomatik olarak oluşturulan dokümanlarda bulunmayacaktır).

İletişim, Extreme Programing ekiplerinin çift programlama yapmasının başlıca nedenlerinden biridir. Değişiklikleri bir takım arkadaşıyla birlikte yaparsanız, hemen her değişikliği bilen iki kişiniz vardır ve bir dahaki sefere başka biriyle eşleşirsiniz, bu nedenle yararlı bilgiler oldukça hızlı bir şekilde yayılır. Bununla birlikte, çeşitli nedenlerle her zaman uygulanamaz. Buna engel olarak, komşularınızla uygun bir andaki değişiklik hakkında konuşabilirsiniz (örneğin, öğle yemeğinde, birlikte öğle yemeğine gelirseniz) veya daha büyük, daha önemli veya daha karmaşık bir değişiklik ise etrafınıza bir posta gönderebilirsiniz.

İkinci durumda, düzgün bir şekilde belgelemek için iyi bir neden olabilir. IMHO tasarım dokümanları, sistem hakkında kaba taneli, yüksek düzeyde bir genel bakış sunarken en iyisidir, ancak uygulama ayrıntıları koddadır ( DRY ilkesine bağlı kalarak ).

Onlarla konuşmayı düşündün mü ? Kısa bir toplantı planlayın: "hey, X nesnesinde bazı değişiklikler yaptım, neyin değiştiğini ve nedenini göstermek istiyorum". Veya bir toplantı çok resmi veya yıkıcı görünüyorsa, her bir kişiyle ayrı ayrı konuşun.

Ekibiniz varsa muhtemelen bir tasarım belgeniz de vardır. Eğer değilse. başlayın. Ve tasarımlarınızı haritalamak için bazı UML aracını kullanın.

Kodunuzda doxygen gibi bir araç kullanabilirsiniz . Şimdi doxygen belgelerini oluşturacak ve belki de gece yapınızın bir parçası olarak düzenli olarak çalıştıracak bir komut dosyası oluşturun (bir gece yapısı yapıyorsunuz, değil mi?).

Yeni olarak vurgulamak için eklentinize doxygen'te özel bir özellik atayabileceğinizi düşünüyorum.

Eğer takım arkadaşlarınız iyi olursa, yeni dokümantasyona girerlerdi.

Şimdi, takım arkadaşlarıma, nesnemin ayarlayabilecekleri daha fazla özelliğe sahip olduğunu nasıl bildirebilirim?

Yaptığınız her küçük şey hakkında takım arkadaşlarınızı bilgilendirmemelisiniz. Aksi takdirde, çok sayıda e-posta göndermeniz gerekir. Bu büyük bir şeyse, küçük bir toplantı yapabilir ve ne yaptığınızı bildirebilirsiniz (Scrum yaparsanız, ayrı bir toplantı ayarlamanıza gerek yoktur).

Otomatik tamamlamayı destekleyen bir IDE kullanıyorsanız, ekip arkadaşlarınız değişikliğinizi fark etmelidir. Umarım koduna yorum yaparsın.