인프런 커뮤니티 질문&답변
작성한 질문수
자바 예외처리 할때 쓴 주석질문이요
해결된 질문
작성
·
107
·
수정됨
1
학습하는 분들께 도움이 되고, 더 좋은 답변을 드릴 수 있도록 질문전에 다음을 꼭 확인해주세요.
1. 강의 내용과 관련된 질문을 남겨주세요.
2. 인프런의 질문 게시판과 자주 하는 질문(링크)을 먼저 확인해주세요.
(자주 하는 질문 링크: https://bit.ly/3fX6ygx)
3. 질문 잘하기 메뉴얼(링크)을 먼저 읽어주세요.
(질문 잘하기 메뉴얼 링크: https://bit.ly/2UfeqCG)
질문 시에는 위 내용은 삭제하고 다음 내용을 남겨주세요.
=========================================
[질문 템플릿]
1. 강의 내용과 관련된 질문인가요? (예/아니오)
2. 인프런의 질문 게시판과 자주 하는 질문에 없는 내용인가요? (예/아니오)
3. 질문 잘하기 메뉴얼을 읽어보셨나요? (예/아니오)
[질문 내용]
안녕하세요. 자바 예외 처리 하면서 본 주석이 궁금해 져서 질문을 남깁니다.
영한님이 throws을 보여주려고, 마우스에 callThrow() 된 것을 보고 (사진 참조)
다른것은 어떻게 될까 해서
그래서 다른 것도 마우스에 되보니, 사진처럼 되엇습니다.
보니까 초록색 주석이 이런 역할을 하더라고요.
그래서 궁금해진 점이 초록색 주석 처럼,
이런 식의 주석이 또 있나요?
그리고 영상을 보니까 단축키를 안쓰고, 타이핑을 하던데, 혹 단축키 같은 게 있을까요?
추가1 : 너무 유용해 보여서요.
추가2 : 글이 좀 너무 이상해서(도둑놈 심보..여서) 수정 하였 습니다.
답변 부탁 드립니다.
답변 2
1
안녕하세요. 생각하는자님, 공식 서포터즈 OMG입니다.
인텔리제이의 유용한 기능이 참 많죠 😀
'TODO' 랑 'FIXME' 주석을 남기면 별도 색상이 적용되고
다른 개발자와 같이 개발하는 상황에서 주석을 남기고, 추가로 'TODO'탭에서 확인할 때 유용합니다 😀
단축키를 안쓰고, 타이핑을 하던데, 혹 단축키 같은 게 있을까요?
이 질문은 내용을 이해하지 못했습니다. 단축키를 안쓰고 타이핑하는 단축키가 무슨 말씀인지 부연설명해주세요.
그리고 주석 기능 관련하여 추가로
/** 를 입력하면
파라미터와 리턴값이 있는 메서드의 경우에도 추가해줍니다.
그리고 자바독 주석에 HTML <태그>로 색상 등 스타일 적용도 가능합니다.
파란색 색상을 추가하는 코드를 추가해보겠습니다.
적용한 것을 확인해보겠습니다.
@return도 예약어로 되어있어서 Returns로 변경해서 보여주네요 😀
@입력하고 control + space를 입력하면 자바독 예약어 리스트도 확인가능합니다.
감사합니다.
그리고 주석 설명 부분에 @Retun 이라고 하면 설명 부분에는 Returns 로 나오는데,
설명에서 변경해서 보여주는게 이 설명이 자바랑 연결되어 있어서 retun을 못 띠우고, returns로 보여준다 라고 이해하면되는건가요?(설명이 너무 이상해서 수정하였습니다.)
네 맞습니다. 설명드린대로 잘 찾아서 확인해보신 것 같습니다.
// TODO 주석은 어떤 것을 해야하는지
// FIXME는 수정이 필요한 코드에
용도에 맞게 사용하시면 될 것 같습니다.
이유까지는 모르겠으나 인텔리제이에서 return -> Returns로 굳이 변경하여 표시한 의도가 있으리라 생각하여 부연설명드린 것입니다.
아무 의미없는 단어를 작성하면 그 단어 그대로 표시합니다.
추가로 더 알려달라고 하셔서
예약어로 등록되어 있는 return을 예시로 해당 예약어를 인식한다를 설명드리기 위함이였습니다.
0
안녕하세요, 인프런 AI 인턴입니다.
질문하신 내용에 관련하여, 주석 작성 방법과 관련된 유사한 질문이 있었습니다. 주석을 작성하는 방식과 관련해 질문한 내용 중 하나는 “초록색 주석문은 뭔가요?“에 대한 것이며, 해당 질문은 IntelliJ IDEA 등의 Integrated Development Environment(IDE)에서 사용 가능한 JavaDoc 주석에 대해 설명하고 있습니다.
JavaDoc 주석은 /** ... */ 형식으로 작성되며, 이러한 주석은 메소드, 클래스 등에 대한 설명문을 작성할 때 사용됩니다. 주석 내용은 HTML 태그를 통해 서식을 지정할 수 있으며, 이 주석을 기반으로 HTML 형식의 API 문서를 자동으로 생성할 수 있는 도구인 JavaDoc 도구에 의해 사용됩니다.
이와 관련해, 초록색 주석문에 대한 설명과 JavaDoc 주석의 작성 방법 및 단축키 사용에 대한 정보는 다음 링크에서 자세히 설명하고 있습니다:
- 초록색 주석문은 뭔가요 .. !
- 이 질문에서는 초록색 주석문, 즉 JavaDoc 주석에 대해 설명하고 있습니다. IntelliJ IDEA에서는 /**를 입력 후 엔터를 누르면 자동으로 JavaDoc 주석을 생성할 수 있습니다. JavaDoc 주석은 코드의 문서화를 도와주며, 코드를 더 잘 이해하고 유지보수하는 데 도움을 줍니다.
단축키 사용에 관한 질문이 있으셨는데, 일반적으로 IDE에서는 JavaDoc 주석을 빠르게 삽입하기 위한 단축키가 제공됩니다. IntelliJ IDEA의 경우 /** 입력 후 엔터 키를 누르는 방법 외에도, 메소드나 클래스 위에서 특정 단축키(플랫폼 및 설정에 따라 다름)를 사용하여 JavaDoc 주석 템플릿을 자동 생성할 수 있는 기능이 있습니다. 사용하시는 IDE의 도움말이나 설정을 통해 해당 단축키를 확인할 수 있습니다.
저는 질문자님의 이해를 돕고자 지식공유자님의 기존 답변을 참고하여 유사한 답변 링크를 추천해드리고 있습니다.
현재 베타 기능으로 답변이 만족스럽지 않을 수 있는 점 양해 부탁드립니다. 🙏
추가적으로 궁금한 점이 있으시면, 이어서 질문해 주세요. 곧 지식공유자께서 답변해 주실 것입니다.
OMG님 죄송합니다.
그냥 따라 치고 이해하는데, 조금 급급 하다 보니까,
/** 이걸 하니(좀 자세히 보니까 영한님도 하고 계시더라고요.)
/**
*
*/
이렇게 되는지를 몰라서, 일반 주석처럼 (ctrl + /, ctrl+shift + /) 이런 단축키 가 없는가? 라는 질문이 나왔던 것입니다.
그리고 여러가지 주석의 사용법을 알켜 주어서 감사합니다.