Comments
Comments
코드에 설명을 남기고 싶을 때가 있죠. Crystal에서 주석(comment)은 # 문자로 시작해요. 코드가 어떤 의도로 쓰였는지 다음에 보는 사람(혹은 미래의 나)에게 남기는 메모예요.
출처: Crystal 공식 문서
본문
주석은 # 문자로 시작해요. 그 줄의 끝까지의 모든 내용이 주석이 돼요. 주석은 단독 줄로 쓸 수도 있고, Crystal 표현식 뒤에 붙여서 쓸 수도 있어요(트레일링 주석).
# This is a comment
puts "hello" # This is a trailing comment
주석의 목적은 코드를 문서화하는 거예요. 공개 문서, 자동 생성된 API 문서를 포함해, 주석을 바탕으로 하는 특별한 기능들이 있는데 이는 문서화(Documenting Code)에서 다뤄요.
더 알아보기
- 주석은
#부터 줄의 끝까지라는 점만 기억하면 돼요. - 공개 API 문서는 주석을 기반으로 자동 생성되므로, 문서화 항목을 함께 보면 좋아요.