기타

vs code에서 주석 색을 바꿔주는 확장 프로그램 Better Comments 사용법

참깨빵위에참깨빵_ 2021. 11. 20. 22:20
728x90
반응형

주석을 친 다음 코드를 치는 내 입장에서 주석은 가끔 코드보다 우선순위가 높아질 때가 있다.

그래서 안드로이드 스튜디오에서 javadoc 주석을 제외한 한 줄 주석, 블록 주석의 색은 쨍한 색으로 사용하는데 vs code에선 어떻게 하는지 찾아보니 이걸 다루는 확장 프로그램이 있었다. 이름은 포스팅 제목에 쓴 대로 "Better Comments"다. 공식 페이지는 아래 링크로 들어가면 볼 수 있다.

 

https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments 

 

Better Comments - Visual Studio Marketplace

Extension for Visual Studio Code - Improve your code commenting by annotating with alert, informational, TODOs, and more!

marketplace.visualstudio.com

 

이걸 적용하면 실제로는 아래처럼 보인다.

 

 

공식 페이지에선 아래 사진을 걸어놨다. 이렇게 쓰라는 것 같다.

 

 

* : 일반 정보
! : 중요한 주의사항
? : 궁금한 것
TODO : 나중에 할 일
@ : 매개변수 설명

 

대충 이 정도로 쓰는 것 같다. 삭선도 그을 수 있으니 필요하면 참고하자.

vs code에서 적용하기 위해선 당연히 확장 프로그램을 다운받아야 한다. 대충 확장 프로그램 입력하고 다운받아준다.

그 다음 파일 > 기본 설정 > 설정으로 들어간다.

 

 

그리고 확장 > Better Comments... > Tags 안의 settings.json에서 편집 순으로 클릭한다.

 

 

그리고 적당한 곳에 아래 코드를 복붙한다.

 

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

 

{} 안의 tag, color 등 속성을 건드리면 된다. 각 속성들의 의미는 아래를 참고하면 된다.

 

tag : 커스텀 코드 추가. 주석 쓰기 전 이 코드를 쓰면 뒤의 옵션들이 적용된다
color : 색깔 변경. 원하는 색의 컬러 코드를 #123456 식으로 입력하면 된다
strikethrough : true면 삭선이 보이고 false면 삭선이 안 보인다
backgroundColor : 배경색. 그냥 transparent로 둬도 된다

 

반응형