본문 바로가기
개발이야기/Etc.

슬기로운 VScode 생활 1 - Better Comments

by hyung12 2020. 4. 21.
반응형

알록달록한 걸 좋아하는 나를 잘 아는 회사 동료가 주석을 알록달록하게 할 수 있다며 추천해준 VScode 익스텐션이 있다

그것은 바로 Better Comments!!!

 

Better Comments는 주석을 달 때 주석의 유형에 따라 색으로 구분하여 더 직관적으로 볼 수 있도록 도와주는 VScode 익스텐션이다

예시(출처: https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)

 

주석 앞에 *, !, ?, TODO, // 이런 문자를 넣어 색을 구분한다

 

  • * : 설명 - 초록
  • ! : 주의 - 빨강
  • ? : 궁금 - 파랑
  • TODO : 할일 - 주황
  • // : 취소 - 검회색

 

이 익스텐션은 사용자 설정 또는 작업 영역 설정에서 구성할 수 있다

 

"better-comments.multilineComments": true
: 멀티라인의 스타일을 지정할지 여부를 제어한다

 

"better-comments.highlightPlainText": false

: 일반 텍스트 주석이 주석 태그의 스타일을 지정할지 여부를 제어

 

"better-comments.tags"

: 5가지 기본 값을 수정할 수도 있고 더 추가도 가능

"better-comments.tags": [
  {
    "tag": "!",
    "color": "#FF2D00",
    "strikethrough": false,
    "backgroundColor": "transparent"
  },
  {
    "tag": "?",
    "color": "#3498DB",
    "strikethrough": false,
    "backgroundColor": "transparent"
  },
  {
    "tag": "//",
    "color": "#474747",
    "strikethrough": true,
    "backgroundColor": "transparent"
  },
  {
    "tag": "todo",
    "color": "#FF8C00",
    "strikethrough": false,
    "backgroundColor": "transparent"
  },
  {
    "tag": "*",
    "color": "#98C379",
    "strikethrough": false,
    "backgroundColor": "transparent"
  }
]

위 설정은 settings.json에서 세팅값을 넣고 수정 또는 추가하면 된다!

 

 

 

Better Comments - Visual Studio Marketplace

OverviewQ & ARating & Review The Better Comments extension will help you create more human-friendly comments in your code. With this extension, you will be able to categorise your annotations into: Alerts Queries TODOs Highlights Commented out code can als

marketplace.visualstudio.com

 

반응형