2015-03-31 12 views
13

JavaDoc'ta bir sınıf oluşturmanın tarihini eklemenin en iyi yolu nedir? Bazı örnekler: dize ile yazar etiketi altındaJavaDoc'ta oluşturma tarihi nasıl oluşturulur

dizeyle yazar etiketi altında

/** 
* Class description 
* 
* @author Author Name 
* created on 2015/04/01 
*/ 
public class ClassName() { 
... 
} 

"Tarih:" "oluşturulmuş" varolmayan @date ile

/** 
* Class description 
* 
* @author Author Name 
* Date: 2015/04/01 
*/ 
public class ClassName() { 
... 
} 

etiket

/** 
* Class description 
* 
* @author Author Name 
* @date 2015/04/01 
*/ 
public class ClassName() { 
... 
} 

Diğer

...

Ve sonunda, en iyi tarih formatı nedir?

April 1, 2015 
2015/04/01 
... 
+0

Oluşturma tarihini veya oluşturma verisini istiyor musunuz? – Mathemats

+0

Bu gerçekten bir görüş meselesidir (ve muhtemelen böyle kapalı olacaktır), bir yorum için bir tarihin nasıl gösterilmesi gerektiği konusunda yakalanmayın. – Mathemats

+1

Tarih formatındaki oylama, herhangi bir programcının ülke, kültür veya saat dilimi farklılıklarına bakılmaksızın net bir şekilde okuyabileceği bir tarih biçimi olabilir. [RFC 3339] gibi (https://tools.ietf.org/html/rfc3339). (ve aynı "bağımsız" set ile okunabilen makine) – xmojmr

cevap

4

Çoğu IDE, yeni sınıflar oluştururken kullanılacak şablonları tanımlamak için bir mekanizmaya sahiptir. Geçerli tarih, genellikle şablonun bir parçası olarak eklenebilir. Örneğin, here belgesi için eclipse ve this sayfasında şablonlarda kullanılabilecek değişkenler gösterilmiştir.