인프런 커뮤니티 질문&답변
작성한 질문수
@param @return 같은 어노테이션을 활용하여 주석을 남기나요?
작성
·
752
1
학습하는 분들께 도움이 되고, 더 좋은 답변을 드릴 수 있도록 질문전에 다음을 꼭 확인해주세요.
1. 강의 내용과 관련된 질문을 남겨주세요.
2. 인프런의 질문 게시판과 자주 하는 질문(링크)을 먼저 확인해주세요.
(자주 하는 질문 링크: https://bit.ly/3fX6ygx)
3. 질문 잘하기 메뉴얼(링크)을 먼저 읽어주세요.
(질문 잘하기 메뉴얼 링크: https://bit.ly/2UfeqCG)
질문 시에는 위 내용은 삭제하고 다음 내용을 남겨주세요.
=========================================
[질문 템플릿]
1. 강의 내용과 관련된 질문인가요? (예/아니오)
2. 인프런의 질문 게시판과 자주 하는 질문에 없는 내용인가요? (예/아니오)
3. 질문 잘하기 메뉴얼을 읽어보셨나요? (예/아니오)
[질문 내용]
주석 강의를 보다가 좀 앞서간 느낌이 있지만 궁금해서 남깁니다. 우아한 형제들 혹은 큰 회사들의 경우 소스 코드가 길기 때문에 주석은 필수 일거 같습니다.
@param @return 같은 어노테이션을 사용하여 주석을 남기는지 아니면 따로 주석을 남기는 규칙? 같은게 존재하는지 궁금합니다.
답변 1
1
안녕하세요. 정동희님
주석의 @param @return의 경우에 정답이 없습니다. 회사나 팀 마다 모두 정책이 다릅니다^^
제가 권장하는 방법은 @param @return의 경우 이미 메서드 코드에 param, return이 존재하기 때문에 이 정보 만으로 충분히 참고가 되는 경우에는 별도로 남기지 않고, 이 정보를 추가로 설명하는 것이 더 나은 상황이라고 판단되는 경우에 적는 것을 권장합니다.
감사합니다.