목표
자바 주석을 활용할 수 있다.
주석 이란?
주석은 문장의 뜻을 쉽게 풀이한 것을 말합니다. 자바, 코딩에서 주석은 복잡한 코드를 좀 더 이해하기 쉽게 설명하기도 하며 무엇보다 다른 사람들과 협업을 할 때도 필요한 요소입니다. 또한 어떤 코드를 비활성화 시킬 때 이용하기도 합니다. 이번 글에서는 주석의 종류와 사용하는 방법에 대해서 알아보겠습니다!
1. 주석의 종류 1 : 행 주석 //
행 주석(//)은 말 그대로 한 줄만 주석 처리를 할 때 사용합니다.
간단한 설명이나 한줄 짜리 코드를 잠시 비활성화시키고자 할 때 쓸 수 있습니다.
(여기서 말하는 비활성화란, 컴파일시 해당 부분은 앱 작동에 영향을 주지 않고 건너뛴다고 생각하시면 됩니다.)
사용 방법은 간단합니다! 슬래시 키(/) 를 2번 // 사용하여 씁니다.
2. 주석의 종류2 : 범위 주석, 블록 주석 /* ~ */
범위 주석, 블럭 주석이라고도 불리는 이 주석은, 여러 줄의 문장을 주석 처리할 때 사용합니다.
사실 주석에 대한 내용이 길어지는게 좋은 주석 사용법은 아니지만, 어쩔 수 없이 여러 줄을 사용하는 상황이라면
위와 같은 방법을 추천합니다.
사용방법은 우선 /* 까지만 입력하고, 그 다음에 엔터키를 입력하면 자동으로 다음줄에 공백이 생기고, 그 다음줄에 */가 생기게 됩니다.
3. 주석의 종류3 : javaDoc
javadoc 란 문서화할 수 있는 주석을 의미합니다.
실제로 다른사람과 협업을 할 때, 앞으로 코드의 유지보수를 위해서는 이 문서화 주석을 잘 활용하는 것이 좋습니다.
사용하는 방법은 우선 /** 까지 입력한 뒤, 엔터키를 입력하면 자동으로 색이 변하면서 */ 가 마지막 쪽에 생기고, 각 행마다 '*' 모양이 들어 갑니다!
javadoc 주석의 경우에는 사용 규칙이 존재하는데, 이 규칙과 실제로 이를 활용해서 작성해보고 문서화하여 어떻게 보이는지 다음 포스팅에서 진행해보도록 하겠습니다.
'Android > Java' 카테고리의 다른 글
| [Android/Java] Calendar to Date, Date to Calendar, String to Date, String to Calendar (0) | 2021.07.14 |
|---|---|
| [Android/Firebase/잡] Firebase analytics 어떤 걸 써야 할까? (0) | 2021.06.02 |
| [Android/코딩 팁] 로그 색상 변경하기, 안드로이드 로그 색상 추천 (0) | 2021.05.09 |
| [Android] 어플 패키지명 확인하는 방법 (0) | 2021.05.04 |
| [Android/java] Intent eamil 전송하기 / 안드로이드 gmail로 보내기 (0) | 2021.05.04 |