Вставьте метку времени «Последнее изменение» в нижний колонтитул Javadoc

Question

Есть ли способ указать дату последнего изменения файла класса?Мне бы хотелось, чтобы на каждой странице javadoc была указана последняя измененная временная метка файла класса, желательно в нижнем колонтитуле.

Я думал, что сделал что-то подобное некоторое время назад, но не могу найти примеровИнтернет и документация для нижнего колонтитула просто указывают, что он может содержать HTML.Так может ли он не иметь какой-либо заполнитель, который будет установлен при создании Javadoc?

Спасибо.

Answer 1

Некоторые системы контроля версий позволяют кодировать маркер, который обновляется при фиксации файла. Если вы поместите это в Javadoc, Javadoc сообщит вам номер ревизии и когда она была в последний раз зафиксирована.

Answer 2

Я думаю, что работа редактора - записать метку времени в код. Вот как Emacs делает это:

package my.tuple;

/**
 * Implementation of an ordered 2-tuple.
 *
 * @date 2013-07-03
 */

public class Pair<A,B>
{
}

// Local Variables:
// time-stamp-pattern: "0/^ \\* @date %:y-%02m-%02d$"
// End:

После этого обработчик документов может прочитать дату. Но стандартный Javadoc не знает даты. Вам нужно Затмение или Doxygen для этого.

Answer 3

Я не думаю, что эта функция доступна в Javadoc.Почему вы не полагаетесь на систему контроля версий, чтобы сделать эту работу за вас?Вы можете иметь, если SVN, ключевые слова, которые будут автоматически заполняться при фиксации (см. svn propset ).Это намного лучше, и вам не нужно беспокоиться об обработке javadoc.

Если может удовлетворить более простой подход, вы можете просто добавить скрипт в нижнюю опцию, например:

-bottom "<font size=\"-1\">Created by `echo $USER`, at `date +%Y-%m-%d\ %H:%M:%S.%N`.</font>"