저는 Java로 코딩할 때 JavaDoc을 신 | 커리어리

저는 Java로 코딩할 때 JavaDoc을 신경써서 작성하는 편입니다. 주석은 아예 없는 것이 낫고, 그냥 코드를 읽기 좋게 작성하는 것이 바람직하다고 생각하는 분들도 계신데요. 저는 읽기 좋게 작성하는 데 실패한 코드에 주석까지 없는 경우를 많이 봐서 그런지 최소한의 주석은 있는 것이 좋다고 생각합니다. 메소드 본문 내에 미주알 고주알 줄줄이 적어둔 주석은 저도 별로 좋아하지는 않고 메소드나 클래스 시그니처 위에 적당히 적어둔 걸 좋아해요. 이 링크는 제가 주석, 특히 JavaDoc을 작성할 때 신경쓰는 것들을 가이드 형식으로 적어둔 글입니다.

Javadoc 작성하기

Johngrib

2022년 2월 26일 오전 10:24

댓글 0

주간 인기 TOP 10

지난주 커리어리에서 인기 있던 게시물이에요!

현직자들의 '진짜 인사이트'가 담긴 업계 주요 소식을 받아보세요.

커리어리 | 일잘러들의 커리어 SNS