Почему в стандартном описании javadoc класса IntelliJ по умолчанию используется нестандартный синтаксис? - PullRequest
44 голосов
/ 15 сентября 2008

Почему для стандартного комментария javadoc класса IntelliJ по умолчанию используется нестандартный синтаксис? Вместо создания строки с помощью «User: jstauffer» можно создать строку с «@author jstauffer». Другие строки, которые он создает (Дата и Время), вероятно, не имеют синтаксиса javadoc для использования, но почему бы не использовать синтаксис javadoc, когда он доступен?

Для справки вот пример:

/**
 * Created by IntelliJ IDEA.
 * User: jstauffer
 * Date: Nov 13, 2007
 * Time: 11:15:10 AM
 * To change this template use File | Settings | File Templates.
 */

Ответы [ 5 ]

52 голосов
/ 15 сентября 2008

Я не уверен, почему Idea не использует тег @author по умолчанию.

Но вы можете изменить это поведение, перейдя на File -> Settings -> File Templates и отредактировав запись File Header на вкладке Includes.

Начиная с IDEA 14 это: File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header

6 голосов
/ 11 января 2015

В AndroidStuido 1.0.2 на Mac

Войти Настройки затем в левом интервале Шаблоны файлов и кодов После выбора файлов и шаблонов кодов справа выберите , включая , выберите вкладку. Заголовок файла и измените заголовок файла.

4 голосов
/ 03 октября 2008

По умолчанию доступно чтение, использование, но оно не соответствует и не предполагает какого-либо стандарта кодирования.

Я думаю, что причина, по которой IntelliJ не использует теги Javadoc по умолчанию, заключается в том, что он избегает возможных помех любым стандартам кодирования / javadoc, которые могут существовать в магазинах разработки. Для пользователя должно быть очевидно, нужно ли изменить значение по умолчанию на что-то более подходящее.

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

3 голосов
/ 18 мая 2009

Потому что это шаблон файла по умолчанию, который вы должны изменить в соответствии со стандартом своей организации или своими вкусами.

Моя лучшая догадка.

1 голос
/ 18 мая 2009

Вполне вероятно, что показанный вами фрагмент заголовка старше, чем javadoc, и был просто заимствован из какого-то стандартного документа кодирования, вероятно написанного для C ++.

...