codestyle; помещенный javadoc прежде или после аннотации?
Параметр времени - это метка времени в миллисекундах, или миллисекунды, прошедшие с эпохи UNIX , которая является чрезвычайно распространенным средством хранения данных, связанных со временем, вы можете найти его в использовании практически в каждой цифровой системе.
Указанная здесь временная метка представляет «2016-05-19 12:06:07». Построенное временное дерево начинается с корня (это удобство моделирования), а затем его дочерним элементом является год (2016), за которым следует месяц (5), а затем дата месяца (19). Похоже, что он не создавал автоматически никаких узлов для временных разрешений за пределами этого.
Имейте в виду, что теперь, когда Neo4j имеет собственные временные значения , которые вы можете использовать в Cypher и хранить в качестве свойств (а также индекса), деревья времени будут менее полезны, как вы всегда можете индексировать поиск по индексированным временным свойствам.
Есть все еще некоторые случаи, когда деревья времени могут все еще быть очень полезными, например, когда вы ищете события, которые произошли в течение некоторой единицы времени, которая игнорирует его родительские единицы ... такие как поиск событий это происходило по понедельникам, независимо от месяца, или в январе, независимо от года и т. д.
4 ответа
Перед аннотацией, поскольку аннотация - это код, который "принадлежит" классу. Смотрите примеры с javadoc в официальной документации.
Вот случайный пример, который я нашел на другой официальной странице Java:
/**
* Delete multiple items from the list.
*
* @deprecated Not for public use.
* This method is expected to be retained only as a package
* private method. Replaced by
* {@link #remove(int)} and {@link #removeAll()}
*/
@Deprecated public synchronized void delItems(int start, int end) {
...
}
Я соглашаюсь со всем вышеупомянутым. Другим может быть полезно, что IntelliJ (Идея), шаблоны стиля кода приводят к сбою обоих ложно положительных (когда @throws определяется правильно, это предупреждает), и ложно отрицательный (когда @throws не определяется, но должен быть) при использовании аннотаций стиля RestEasy. Я поместил свой javadocs выше всего остального, затем аннотации, затем кодирую.
См. отчет об ошибках здесь: https://youtrack.jetbrains.com/issue/IDEA-220520
Все сводится к читабельности. На мой взгляд, код более читабелен, если аннотации расположены непосредственно над методом/полем.
Я согласен с уже данными ответами.
Аннотации являются частью кода, в то время как javadoc является частью документации (отсюда и название).
Поэтому для меня кажется разумным держать части кода вместе.