2015-03-31 13 views
13

Jaki jest najlepszy sposób wstawienia daty utworzenia klasy w JavaDoc? Kilka przykładów:Jak wstawić datę utworzenia w JavaDoc

Poniżej znacznika autora z napisu „utworzone na”

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

Poniżej znacznika autora z napisu „Data:”

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

Z nieistniejącego @date tag

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

Inne ...

I ostatecznie, jaki jest najlepszy format daty?

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

Czy chcesz datę utworzenia lub dane o stworzeniu? – Mathemats

+0

To naprawdę zależy od opinii (i prawdopodobnie zostanie zamknięte jako takie), nie daj się złapać, jak powinna być wyświetlana data komentarza. – Mathemats

+1

Moim zagłosowaniem na format daty byłby format daty, który każdy programista może czytać jednoznacznie niezależnie od kraju, kultury lub różnic strefy czasowej. Podobnie jak [RFC 3339] (https://tools.ietf.org/html/rfc3339). (i odczytywalne maszynowo z tym samym zestawem "niezależnie") – xmojmr

Odpowiedz

4

Większość IDE posiada mechanizm definiowania szablonów do użycia podczas tworzenia nowych klas. Bieżącą datę można zwykle wstawić jako część szablonu.

Na przykład: here jest dokumentacją dla Eclipse, a strona this pokazuje zmienne, które mogą być używane w szablonach.