Javadoc yorum. İhtiyacınız mı yoksa gereksiz mi?

Question

Aşağıdaki kod parçası Verilen:

/** 
* Initializes a new instance. 
* 
*/ 
public Collector() { 
    this.map = new HashMap<>(); 
} 

Javadoc comment konsantre edin: Bu yapıcı çok fazla bir şey olmaz. Öyleyse, Javadoc'u yazmanın doğru yolu nedir? Yukarıda gösterildiği gibi? Bu, aynı zamanda, gereksiz yere aynı zamanda kusursuz olacaktır, çünkü bir kurucu yeni bir örneği başlatmayı amaçlamaktadır.

Yani, bir yandan, Javadoc yorumlarında gereksiz bilgi yazmak istemiyoruz, öte yandan Javadoc yorumu olmalı (var mı?).

Yani, kısaca, anlamı ne kadar anlamsız, Javadoc bu durumlarda nasıl yazılır?

Answer 1

Kodun okuyucusunun kim olduğuna ve kurucunun işlevselliğinin ne kadar açık olduğuna bağlıdır. Ya javadoc, bir okuyucu için (kapalı kaynak) tek bilgi kaynağıdır, ya da okuyucu, kaynaktan ne olup bittiğini kolayca kavrayabilir. Projelerimizde, javadoc'un açık bir işlevselliği yok. Bazı formalizm javadoc gerektirdiğinde, basitçe/** Oluşturucu kullanırız. */sadece formalizmi tatmin etmek için.