Спецификация аннотации кода — шаблон аннотации метода Java-класса конфигурации IDEA

спецификация кода
Спецификация аннотации кода — шаблон аннотации метода Java-класса конфигурации IDEA

1. Введение

Когда команда развивается, чем четче назначение бизнес-модулей и чем полнее управление комментариями кода, тем больше возможностей для последующего обслуживания и тем удобнее управлять потом. Вы знаете, он также действует как «текстовый кирпич». Комментарии не должны быть очень подробными, просто кратко опишите функцию блока метода блока кода. Иначе, когда я оглянусь в марте, я буду ругать людей.Поругавшись, я нахожу, что написал это сам, тск тск тск...

Три часто используемых метода аннотирования Java

    // 声明常量
    int number;

    /*
     * 类主函数
     */
    public static void main(String[] args) {
    }

    /**
     * @param masterId	品牌商Id
     * @param shopId	店铺Id
     * @param skuId		商品skuId
     * @description: 校验商品标识码与店铺的所属关系
     * @return: net.jdcloud.APIECRM.model.ValidateSkuUsingGETResponse
     * @author: niaonao
     * @date: 2020/01/13
     */
    public static ValidateSkuUsingGETResponse validateSkuUsing(String masterId, String shopId, String skuId){
        return null;
    }

2. Пользовательские шаблоны аннотаций

2.1 Шаблон аннотации класса

2.1.1 Шаблон конфигурации

Добавьте шаблон комментария по пути меню File-Settings-Editor-File и Code Templates-Incudes-File Header, настройте шаблон и нажмите Apply OK, чтобы применить.

пользовательский шаблон аннотации

/**
 * @className: ${NAME}
 * @description: TODO 类描述 
 * @author: niaonao
 * @date:  ${DATE}
 **/

Новый интерфейсный файл автоматически генерирует комментарии, эффект следующий

/**
 * @className: CrowdService
 * @description: 人群对象业务
 * @author: niaonao
 * @date: 2020/1/13
 **/
public interface CrowdService {
}

2.1.2 Неполная справочная таблица переменных шаблона пользовательской аннотации

предопределенные переменные Описание
${NAME} the name of the current file
${PACKAGE_NAME} name of the package in which the new file is created
${USER} current user system login name
${DATE} current system date
${TIME} current system time
${YEAR} current year
${MONTH} current month
${MONTH_NAME_SHORT} first 3 letters of the current month name. Example: Jan, Feb, etc.
${MONTH_NAME_FULL} full name of the current month. Example: January, February, etc.
${DAY} current day of the month
${DAY_NAME_SHORT} first 3 letters of the current day name. Example: Mon, Tue, etc.
${DAY_NAME_FULL} full name of the current day. Example: Monday, Tuesday, etc.
${HOUR} current hour
${MINUTE} current minute
${PROJECT_NAME} the name of the current project

2.2 Шаблон аннотации метода

2.2.1 Шаблон конфигурации

Добавьте новую группу шаблонов по пути меню File-Settings-Editor-Live Templates с произвольным именем JavaTemplateGroup. Выберите группу шаблонов и нажмите кнопку «Добавить» справа, чтобы создать новый шаблон.

  • Аббревиатура настраивается как *.
  • Описание Информация о пользовательском описании.
  • Пользовательский шаблон текста шаблона
*
 $param$
 * @description: TODO
 * @return: $return$
 * @author: niaonao
 * @date: $date$
 */

Редактировать переменные Редактировать переменные

  • Выражение возврата переменной - methodReturnType()
  • Выражение переменной даты - date()
  • Выражение параметра переменной
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')};return result", methodParameters())

Если появится предупреждающее сообщение Нет применимых контекстов, щелкните Определить и выберите Java.

Здесь Expend With настраивается как клавиша Enter, а комментарий генерирует ярлык, в зависимости от личных привычек, или клавишу Tab.

Щелкните Применить OK, чтобы применить конфигурацию. Эффект следующий

    /**
     * @param: masterId
     * @param: shopId
     * @param: skuId
     * @description: TODO
     * @return: net.jdcloud.APIECRM.model.ValidateSkuUsingGETResponse
     * @author: niaonao
     * @date: 2020/1/13
     */
    public static ValidateSkuUsingGETResponse validateSkuUsing(String masterId, String shopId, String skuId) {
        return null;
    }

2.2.2 Дополнительные инструкции

Шаблон аннотации метода нельзя использовать вне метода, если он используется вне метода, @param не может быть получен, а аннотация имеет значение @param null;

Шаблон комментария к методу занимает /**, при его использовании при объявлении переменной можно поставить лишний пробел после /** и нажать Enter, и шаблон метода не сработает.

Шаблон аннотации класса создается при создании файла. Созданный файл не будет запускать шаблон, но будет запускать шаблон аннотации метода.

Power By niaonao, The End, Thanks

Категории