Better Comments Extension 사용법

Better Comments는 Visual Studio Code에서 주석을 보다 유용하게 관리할 수 있도록 도와주는 확장 프로그램입니다. 이 확장을 사용하면 코드 내에서 주석을 강조하고, 알림, 질문, TODO 항목 등으로 구분할 수 있어 코드 가독성을 높이고 협업 시 유용하게 활용할 수 있습니다. 아래는 Better Comments를 사용하는 방법과 설정에 대한 자세한 설명입니다.

 

1. Better Comments 설치하기

1. Visual Studio Code를 열고, 사이드바에서 Extensions 아이콘을 클릭합니다.
2. 검색창에 "Better Comments"를 입력하고, 나타나는 목록에서 해당 확장을 찾아 설치합니다.

 

2. 주석 사용하기

Better Comments 확장 프로그램은 주석을 다음과 같이 색깔과 유형별로 구분합니다:

• // : 일반 정보 주석 (기본 색상)
• ! : 중요한 경고 주석 (빨간색)
• ? : 질문 주석 (파란색)
• TODO : 해야 할 일 (주황색)
• * : 강조된 주석 (녹색)

이러한 구분을 통해 각 주석의 중요성을 시각적으로 쉽게 파악할 수 있습니다.

 

3. 색상 및 스타일 사용자 정의하기

Better Comments의 매력 중 하나는 주석의 색상 및 스타일을 사용자 정의할 수 있다는 점입니다. 이를 위해서는 다음과 같은 절차를 따릅니다.

1. 파일 > 기본 설정 > 설정으로 이동합니다.
2. 오른쪽 상단의 Open Settings (JSON) 아이콘을 클릭하여 settings.json 파일을 엽니다.
3. 아래의 코드를 복사하여 붙여넣기 합니다.

"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
  }
]

각 속성에 따라 주석의 색상, 스타일 등을 조정할 수 있습니다. 예를 들어, color 속성에 원하는 색상 코드를 입력하여 색상을 변경할 수 있습니다.

 

4. 새 주석 스타일 만들기

Better Comments는 새로운 주석 스타일을 추가할 수 있는 기능도 제공합니다. 원하는 태그와 스타일을 설정한 후, VS Code의 창을 새로 고치면 추가한 스타일이 적용됩니다.

 

[Extensions] VScode에서 코멘트를 슬기롭게 사용하는 방법 (feat. Better Comments)

[Extensions] VScode에서 코멘트를 슬기롭게 사용하는 방법 (feat. Better Comments)

 

Better Comments 확장은 코드 내 주석을 시각적으로 개선하여 코드 작성 및 유지보수 시 큰 도움을 줍니다. 설치 및 설정이 간편하며, 사용자 맞춤화도 가능하여 많은 개발자들에게 유용한 도구입니다. 이를 통해 협업 시 코드의 이해도를 높이고, 생산성을 향상시킬 수 있습니다.