[Develop/Tools] VSCODE vscode-author-generator Extension 사용

VSCODE vscode-author-generator 사용

여러 개발 회사에서는 각각의 코드 컨벤션을 가지고 있다. 코드의 간격을 탭으로 할지? 스페이스로 할지? 

각 자바 클래스나 함수에 주석은 어떤 규약으로 달아 놔야 하는지, glt commit 메시지는 어떻게 하는가 등등

많이 있을 것이다.

 

회사랑은 별개지만 지인이나 친구들과 같이 스터디 등 토이 프로젝트를 진행하면서 누가 만들었고 무엇을 목적으로

생성한 소스코드인지를 볼 수 있도록 file-header Extension으로 사용하면서 추천하고자 블로그에 포스팅한다.

vscode-author-generator 설치

vscode-author-generator는 각 VSCODE에서 좌측에 Extensions 탭을 이용해서 검색하여 설치해도 되고

Ctrl + Shift + x 를 눌러 Extentions 탭을 열어 설치해도 된다.

혹시 몰라 VSCODE MarketPlace URL도 아래 첨부한다.

marketplace.visualstudio.com/items?itemName=edwardhjp.vscode-author-generator

vscode-author-generator - Visual Studio Marketplace

vscode-author-generator 사용

vscode-author-generator가 많은 file header Extension 중에 맘에 들었던 이유는 심플하다.

아래와 같이 작성자, 작성자의 메일, 생성일자, 수정 일자, 설명으로 필요한 내용만 표출한다.

/**
 * @author hoons-up
 * @email test@gmail.com
 * @create date 2020-12-09 13:37:45
 * @modify date 2020-12-09 13:37:45
 * @desc [description]
 */

이제는 주석을 사용할 때마다 각 정보를 미리 vscode에 기입해야 한다. 문서에도 볼 수 있듯이 

- author-generator.author: 작성자 이름 설정

- author-generator.email: 작성자 메일 서정

- author-generator.dateFormat: 날짜 포맷 설정

- author-generator.updateOnSave: 저장할때 수정 일자를 자동으로 업데이트할지 여부

 

이렇게 4가지가 있는데 나같은 경우엔 dateFormat은 기본을 사용하고 updateOnSave는 true로 사용했다.

그럼 저 4가지 설정을 vscode에 설정하여 보자.

 

VSCODE 헤더에 FIle -> Preferences -> Settings로 이동하여 아래 사진처럼 우측 상단에 아이콘을 누르거나

Ctrl + p 단축키로 settings.json 파일을 찾아도 된다.

 

다음으로 settings.json에 아래와 같이 자신에 맞는 헤더 설정을 추가해주면 된다.

  "author-generator.author": "hoons-up",
  "author-generator.email": "test@gmai.com",
  "author-generator.updateOnSave": true

 

마지막으로 작성하고 있는 파일로 이동하여 Ctrl + Shift + p 단축키로 Generate Author Info를 선택하면 

자신이 설정한 헤더 주석이 파일에 생성되는 것을 볼 수 있다.

 

회사에 정해진 컨벤션이 없거나 개인적으로 프로젝트 진행 시 팀원들과 함께 사용하여 나와 팀원 간 

사소한 커뮤니케이션을 도와보자.