Başka birinin kodunu değiştirdiğimde Javadoc'u nasıl değiştirebilirim?

Question

Başka birinin kodu üzerinde çalışıyorum ve önemli değişiklikler yapıyorum. (Onu orijinal olarak kullandığıdan farklı bir veritabanına dönüştürüyorum.) Javadoc yorumlarında, kodun orijinal yazarı olmadığımı, ancak buna katkıda bulunduğumu nasıl açıklarım. Bunu zaten yapmanın temiz mi, standart bir yolu var mı? Googling'im bunu çözmeme yardım etmiyor.

Örnek: Böylece indirdi tüm kendim ben de orijinal yazarın adını bilmiyorum

/** 
* This class does some really awesome stuff. 
* 
* @author Steph the Great - Modified to use PostgreSQL instead of Derby; 
*   added comments to the code 
*/ 

olduğunu. . .

Answer 1

Bu yorumlar javadoc'a ait değil :-) Javadoc sözleşmeyi açıklamalıdır - bu, otomatik olarak oluşturulmuş "belgelerde" ifadesini açıklar ve görüntülenir. Geri kalanlar sadece normal yorumlar ya da belki bu durumda daha iyi, SCM kayıt girişleri ve javadoc'ta yer yok!

ben muhtemelen sadece orijinal yazarın ayrılmak ama krediyi isterseniz ...

... @author javadoc başvurusuna bakın ve onu defalarca eklenebilir unutmayınız olacaktır. Bu bölüm explicitly relates to multiple authors ve sipariş vb

/** 
* This class does some really awesome stuff. 
* It uses PostreSQL. 
* 
* @author Steph the Great 
* @author Freddy Four Fingers 
*/ 
// DEC2012 - Fred - Modified to use PostgreSQL instead of Derby (but really, use SCM!) 
class Awesome { ... } 

Mutlu kodlama. Yazar bilinmiyorsa görevde örneğe biraz ilgisiz soru üzerine

---

Notlar ... sonra birkaç şey yapılabilir. İlk ve en önemlisi , orijinal kaynağın elde edildiği yere bir bağlantı veya referans ekleyin - isteğe bağlı olarak "Bunu orijinal olarak yazmadım" açıklığı için de not edilebilir.

Ardından tercihinize bağlı olarak:

1. bir @author alanı belirtmeyin - bile kendinizi. Gerekli değil.
2. Kendinizi tek yazar olarak ekleyin; Orijinal kaynak yukarıda belirtildiği gibi javadoc
3. Bir kukla yazar ekleyin ve kendinizi ikinci yazar olarak ekleyin. @author Unknown@author unascribed (bkz. Yorumlar ve @author).
4. Varsa, lisans açısından ne yaparsanız yapın.

Answer 2

Birden fazla @author etiketine sahip olabilirsiniz. Dolayısıyla, bir derste kapsamlı değişiklikler yaptıysanız, kendi adınızla yeni bir @author etiketi eklemeniz yeterlidir. Yaptığınız değişiklikleri listelemeye gerek yok --- revizyon tarihi bunu yeterince iyi göstermeli.