Использование шаблонов файлов и кода

Введение в шаблоны файлов и кода

Шаблоны файлов и кода можно рассматривать как предустановленные структуры кода, которые автоматически добавляются в новые файлы при их создании в проекте. Поскольку текстовое описание может быть не совсем ясным, ниже приведены демонстрационные GIF-анимации.

• Как показано на GIF-анимациях выше, по умолчанию IntelliJ IDEA добавляет стандартные комментарии к новым классам, которые часто не соответствуют корпоративным стандартам кодирования. Поэтому обычно требуется настроить их в соответствии с внутренними правилами.

• Как показано на GIF-анимациях выше, это комментарии, настроенные в соответствии с моими собственными требованиями, что делает их более удобными.

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

• Официальная документация: https://www.jetbrains.com/idea/help/file-and-code-templates.html## Настройка шаблонов файлов и кода

• Как показано на рисунке 1, шаблоны файлов и кода поддерживают основные типы файлов.
• Как показано на рисунке 2, это шаблон кода для Java-файла, в котором ${PACKAGE_NAME} и ${NAME} являются зарезервированными переменными IntelliJ IDEA.
• Как показано на рисунке 3, шаблоны файлов и кода в IntelliJ IDEA могут быть написаны с использованием языка шаблонов Velocity Template Language (VTL). Как показано на рисунке 2, #if ... #end и #parse являются синтаксисом VTL.
• Как показано на рисунке 4, это информация о текущем шаблоне файла и описание зарезервированных переменных.
• Как показано на рисунке 5, эти четыре кнопки являются основными операциями для шаблонов файлов и кода. Четыре операции включают:

• Create Template — создание нового шаблона файла и кода.
• Remove Template — удаление шаблона файла и кода. Шаблоны, показанные на рисунке 1, не могут быть удалены, только пользовательские шаблоны.
• Copy Template — копирование шаблона файла и кода.
• Reset To Default — сброс шаблона файла и кода до его исходного состояния.> * Как показано на приведенном выше GIF, по умолчанию IntelliJ IDEA не предоставляет шаблон для создания XML-файлов, поэтому я создал собственный шаблон файла под названием: YouMeek XML, с расширением: xml, инициализационное содержимое которого: <?xml version="1.0" encoding="UTF-8"?>. Вы можете дополнить инициализационное содержимое в соответствии со своими требованиями.

• Как показано на приведенном выше GIF, IntelliJ IDEA поддерживает и другие типы файлов, которые вы можете создавать, поэтому вы можете не беспокоиться о том, что какой-либо тип файлов не поддерживается. Основные типы файлов уже включены.

• Как показано на приведенном выше GIF, шаблон файла File Header, показанный на отметке 1, используется в предыдущем шаблоне Java-файла, где используется команда #parse("File Header.java").

• Как показано на приведенном выше GIF, отметка ${DESCRIPTION} является переменной, которую мы определяем самостоятельно. Формат определения переменных может быть двух видов: $переменная или ${переменная}.
• Переменные, определенные самостоятельно, должны быть заполнены при создании соответствующего файла, что было показано в приведенном выше GIF.

• Как показано на приведенном выше GIF, когда вам нужно использовать фиксированное значение для переменной, которая используется в нескольких местах, вы можете использовать синтаксис VTL: #set( $переменная = "значение переменной" ); для установки значения переменной.

• Из-за того, что редко кто изменяет шаблоны кода в модуле Code, он находится в самом конце. Новые шаблоны кода или удаление существующих шаблонов кода в модуле Code недоступны.
• Как показано на приведенном выше GIF, отметка 1 показывает, что при использовании быстрой команды для создания тестового метода для определенного класса, используется шаблон кода Code. Таким образом, этот шаблон кода используется для автоматического создания определенного кода в IntelliJ IDEA.

Предопределенные переменные шаблонов файлов и кодаИз-за очевидности названий переменных, здесь нет необходимости в подробном объяснении. Приведены официальные английские объяснения:

• ${PACKAGE_NAME} - имя целевого пакета, где будет создан новый класс или интерфейс.
• ${PROJECT_NAME} - имя текущего проекта.
• ${FILE_NAME} - имя PHP-файла, который будет создан.
• ${NAME} - имя нового файла, которое вы укажете в диалоговом окне "Создание нового файла" при создании файла.
• ${USER} - имя пользователя, которое используется для входа в систему.
• ${DATE} - текущая дата системы.
• ${TIME} - текущее время системы.
• ${YEAR} - текущий год.
• ${MONTH} - текущий месяц.
• ${DAY} - текущий день месяца.
• ${HOUR} - текущий час.
• ${MINUTE} - текущая минута.
• ${PRODUCT_NAME} - имя IDE, в которой будет создан файл.
• ${MONTH_NAME_SHORT} - первые три буквы названия месяца. Пример: Янв, Фев, и т. д.
• ${MONTH_NAME_FULL} - полное название месяца. Пример: Январь, Февраль, и т. д.

Тип файлов в предустановленных переменных для PHP содержит больше вариантов, подробнее можно узнать на официальном сайте:> * Описание переменных: https://www.jetbrains.com/idea/help/file-template-variables.html