Как вы установите автора в комментарии класса Java?

Question

В нашей собственной разработке обычно пишут авторы java-класса в комментарии к классу.

Он будет записан в виде

* @author Doe, John (john.doe@example.com)

Все авторыбудет указан в этой форме, тот, кто больше всего работал в этом классе, будет указан первым.

Мой вопрос (ы): Как вы справляетесь с таким требованием?Вы устанавливаете авторство в комментарии или используете свой исходный репозиторий для отслеживания этой информации?В каком формате лучше написать имя автора и адрес электронной почты?

Answer 1

Ваш источник контроля имеет наиболее правильную информацию о том, кто, что и когда делал в классе.Это единственный надежный источник информации (за исключением случаев, когда несколько пользователей используют один и тот же пользователь / пароль).

Меня обычно не волнует тег @author, который в большинстве случаев автоматически вставляется в средупри создании класса.Используйте его как хотите, и выберите нужный формат.

Кстати, кто больше работает?Тот, кто пишет весь код класса, или тот, кто изменяет одну строку кода, чтобы исправить производственную ошибку после двух недель исследования?

Answer 2

Мне нравится этот формат:

* @author <ul><li>John Doe (john.doe@example.com)</li><li>...</li>...</ul>

Он печатает список, об имени и электронной почте.Мне нравится видеть имя и адрес электронной почты в этом формате.Это легко читать.Формат Surname, name мне показался слишком формальным.Он не предназначен для заказа по фамилии, так зачем?