안드로이드 스튜디오 주석 색상 - andeuloideu seutyudio juseog saegsang

목표

자바 주석을 활용할 수 있다.

주석 이란?

주석은 문장의 뜻을 쉽게 풀이한 것을 말합니다. 자바, 코딩에서 주석은 복잡한 코드를 좀 더 이해하기 쉽게 설명하기도 하며 무엇보다 다른 사람들과 협업을 할 때도 필요한 요소입니다. 또한 어떤 코드를 비활성화 시킬 때 이용하기도 합니다. 이번 글에서는 주석의 종류와 사용하는 방법에 대해서 알아보겠습니다!

1. 주석의 종류 1 : 행 주석 //

행 주석(//)은 말 그대로 한 줄만 주석 처리를 할 때 사용합니다.

간단한 설명이나 한줄 짜리 코드를 잠시 비활성화시키고자 할 때 쓸 수 있습니다.

(여기서 말하는 비활성화란, 컴파일시 해당 부분은 앱 작동에 영향을 주지 않고 건너뛴다고 생각하시면 됩니다.)

사용 방법은 간단합니다! 슬래시 키(/) 를 2번 // 사용하여 씁니다.

2. 주석의 종류2 : 범위 주석, 블록 주석 /* ~ */

범위 주석, 블럭 주석이라고도 불리는 이 주석은, 여러 줄의 문장을 주석 처리할 때 사용합니다.

사실 주석에 대한 내용이 길어지는게 좋은 주석 사용법은 아니지만, 어쩔 수 없이 여러 줄을 사용하는 상황이라면

위와 같은 방법을 추천합니다.

사용방법은 우선 /* 까지만 입력하고, 그 다음에 엔터키를 입력하면 자동으로 다음줄에 공백이 생기고, 그 다음줄에 */가 생기게 됩니다.

3. 주석의 종류3 : javaDoc

javadoc 란 문서화할 수 있는 주석을 의미합니다.

실제로 다른사람과 협업을 할 때, 앞으로 코드의 유지보수를 위해서는 이 문서화 주석을 잘 활용하는 것이 좋습니다.

사용하는 방법은 우선 /** 까지 입력한 뒤, 엔터키를 입력하면 자동으로 색이 변하면서 */ 가 마지막 쪽에 생기고, 각 행마다 '*' 모양이 들어 갑니다!

javadoc 주석의 경우에는 사용 규칙이 존재하는데, 이 규칙과 실제로 이를 활용해서 작성해보고 문서화하여 어떻게 보이는지 다음 포스팅에서 진행해보도록 하겠습니다.

나만을 위한 블로그

기타

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

참깨빵위에참깨빵 2021. 11. 20. 22:20

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

그래서 안드로이드 스튜디오에서 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로 둬도 된다