IDEA 코드 규범 플러그 인 P3C+코드 주석 템 플 릿 설정 방법

IDEA 설정 아 리 규범 플러그 인 P3C
idea->File->Settings->플러그 인
Plugins 搜索插件
검색 상자 에서 검색:Alibaba Java Coding Guidelines 설치 플러그 인 을 다운로드 하고 설치 후 IDEA 를 다시 시작 합 니 다.편집기 에 들 어가 서 우 클릭 하면 많은 것 을 발견 할 수 있 습 니 다.
자,검사 규범 과 닫 기 검사.
使用规范检查
이 자바 파일 에 문제 가 있 는 지 확인 하고 힌트 를 드 립 니 다.
规范提示
클래스 나 방법 에 javadoc 주석 이 부족 한 경우 도 종종 있 습 니 다.예 를 들 어:
  • 모든 종 류 는 창조 자 정 보 를 추가 해 야 합 니 다
  • 모든 추상 적 인 방법(인터페이스 에 있 는 방법 포함)은 자바 doc 주석 을 사용 해 야 합 니 다.반환 값,파라미터,이상 설명 을 제외 하고 이 방법 이 무엇 을 하고 어떤 기능 을 실현 하 는 지 지적 해 야 합 니 다.
  • 자바 류,방법 설명 템 플 릿 을 추가 하여 이러한 수 요 를 만족 시 킵 니 다.
  • 개발 도구:IDEA
  • 코드 포맷 템 플 릿:아 리 포맷 템 플 릿
  • 주석 템 플 릿 샘플
  • 
    /**
     *      
     * Demo class (  )
     * 
     * @author keriezhang
     * @date 2016/10/31 20:07
     */
     public class CodeNoteDemo {
     }
    
    /**
     *       
     * fetch data by rule id (  )
     * 
     * @author keriezhang
     	 * @date 2016/10/31 20:07
     * @param ruleId rule id
     * @param page page number
     * @param jsonContext json format context
     * @return Result<XxxxDO>
     */
     Result<XxxxDO> fetchDataByRuleId(Long ruleId, Integer page, String jsonContext);
    IDEA 템 플 릿 설정 절차
    전역 USER Help->Edit Custom VM Options... 설정 전역 USER 설정,자동 으로 생 성 된 주석 에 있 는 작성 자@author 속성 을 채 울 수 있 습 니 다.-Duser.name=xxx 줄 추가(xxx 이름)
    全局中USER
    클래스 설명 템 플 릿 settings->Editor->File and Code Templates->files->class 설정
    添加class模板
    설명 템 플 릿 내용 추가:
    
    /**
     * ${description}
     * @author ${USER}
     * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
     **/
    자바 파일 을 새로 만 들 때 입력 클래스 설명 description 을 알려 줍 니 다.생 성 된 파일 형식 은 다음 과 같 습 니 다.
    
    package tuan.press.test;
    
    /**
     *    
     * @author keriezhang
     * @date 2016/10/31 20:07
     **/
    public class MyTests {
    }
    설정 방법 설명 Editor->Live Template->java 새 라 이브 템 플 릿 을 다음 과 같이 설정 합 니 다.
    方法模板描述
    5 단계,필드 설정 적용 은 다음 과 같 습 니 다:
    添加java所以场景
    6 단계 템 플 릿 변 수 는 다음 과 같 습 니 다.
    在这里插入图片描述
    설정 매개 변수
  • 줄 임 말 약어
  • 템 플 릿 템 플 릿 text:
  • 
    *
     * 
     * @author $user$
     * @date $data$ $time$$param$
     * @return $return$ 
     */
    변수 설정
  • user:user()
  • date: date("yyyy/MM/dd")
  • time:time("HH:mm")
  • param:groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {result+='\' + ' * @param ' + params[i] + ' '}; return result;}", methodParameters());
  • return:methodReturnType()
  • 방법 설명 사용
    자바 방법 에/**를 입력 한 후 tab 키 를 누 르 면 방법 위 에 방법 설명 을 생 성 할 수 있 습 니 다.다음 과 같 습 니 다.
    
    /**
     * (①    )
     * @author keriezhang
     * @date 2016/05/07 10:07
     * @param message (②    )
     * @param name (②    )
     * @return java.lang.String (③     )
     */
    public String myTest(String message,String name){
     return "";
    }
    IDEA 코드 규범 플러그 인 P3C+코드 주석 템 플 릿 설정 방법 에 관 한 이 글 은 여기까지 소개 되 었 습 니 다.더 많은 관련 IDEA 코드 규범 플러그 인 P3C 내용 은 우리 의 이전 글 을 검색 하거나 아래 의 관련 글 을 계속 찾 아 보 세 요.앞으로 많은 지원 을 바 랍 니 다!

    좋은 웹페이지 즐겨찾기