Computer >> 컴퓨터 >  >> 프로그램 작성 >> Ruby

Ruby 주석의 5가지 유형 및 올바르게 사용하는 방법

Ruby의 주석은 무엇입니까?

Ruby 주석은 귀하 또는 다른 개발자에게 도움이 될 수 있는 정보를 코드에 추가합니다.

가장 일반적인 유형의 댓글은 한 줄짜리 댓글입니다.

구문은 다음과 같습니다. :

# I like apples & oranges

3가지 주의사항 :

  1. 주석은 파운드(# ) 기호
  2. 댓글 내용과 댓글 시작 부분 사이에 공백을 넣어 가독성을 높였습니다.
  3. 코멘트 안의 모든 내용은 코드처럼 보이더라도 코드로 해석되지 않습니다. 즉, 일시적으로 비활성화하려면 코드를 주석 처리하세요.

이러한 주석은 단독으로 사용하거나 코드 줄 끝에 인라인으로 사용할 수 있습니다.

좋아요 :

[].size # get array size

다른 종류의 댓글이 있습니까?

예, 매직 댓글, 여러 줄 댓글 및 ERB 댓글이 있습니다.

살펴보겠습니다!

Ruby에서 여러 줄 주석을 사용하는 방법

Ruby에서는 일반 한 줄 주석으로 여러 줄 주석을 수행합니다.

어떤 사람들은 이것을 "댓글 차단"이라고 부릅니다.

예시 :

# aaa
# bbb
# ccc

이것이 바로 루비에서 코드 블록을 주석 처리하는 방법입니다.

최신 코드 편집기를 사용하면 코드 블록을 선택하고 전체에 주석을 추가할 수 있습니다. 키보드 단축키를 사용하므로 추가 노력이 필요하지 않습니다.

그러나 특별한 여러 줄 주석 구문이 있습니다.

이렇게 생겼어요 :

=begin
This is a comment...
a
b
c
=end

아무도 이 구문을 사용하지 않습니다...

보기 흉하고 들여쓰기가 된 것(메소드와 같이) 안에는 사용할 수 없지만 야생에서 발견하면 존재한다는 사실을 아는 것이 좋습니다.

쉬뱅 댓글

시발(#! )는 유닉스 셸(예:bash)에 이 파일을 해석하는 방법을 알려주는 특별한 종류의 주석입니다.

파일 상단에 이 댓글을 추가하면...

올바른 권한이 있다고 가정하면 Ruby 파일을 실행 파일로 실행할 수 있습니다. 그렇게 하기 위해.

다음은 shebang 주석의 모양입니다.

#!/usr/bin/env ruby

또한 경고 옵션과 같은 특정 명령줄 옵션을 설정할 수 있습니다.

:

#!/usr/bin/env ruby -w

이 코드를 실행할 때마다 이 옵션과 함께 실행되므로 수동으로 전달할 필요가 없습니다.

매직 댓글 사용 방법

매직 코멘트는 Ruby 인터프리터의 동작을 어떤 식으로든 변경합니다.

예를 들어 :

frozen_string_literals 주석은 기본적으로 문자열을 고정시킵니다.

이렇게 생겼어요 :

# frozen_string_literal: true

또 다른 마법의 주석을 사용하면 파일의 인코딩을 변경할 수 있습니다.

예시 :

# encoding: utf-8

여기 흥미로운 내용이 있습니다. warn_indent comment :

# warn_indent: true

들여쓰기가 잘못될 때마다 경고가 표시됩니다.

:

def comments
  end

결과 :

warning: mismatched indentations at 'end' with 'def' at 3

ERB 코멘트

Rails 보기에 ERB를 사용하고 있고 주석을 추가해야 하는 경우...

그런 다음 이 구문을 사용할 수 있습니다. :

<%# ERB comment %>

나는 당신이 논평이 필요하지 않도록 대부분의 논리를 당신의 관점에서 제외해야 한다고 생각하기 때문에 나는 이것의 열렬한 팬이 아닙니다.

디버깅을 위해 일부 코드를 비활성화하려고 합니다. ?

그런 다음 해당 코드를 삭제하고 git 또는 사용 중인 버전 관리 시스템을 신뢰하세요.

요약

일반 주석(# ), 시발 주석(#! ) 및 마법 주석(# frozen_string_literal: true )!

이 기사가 도움이 되었다면 친구와 공유하여 친구도 이 기사를 즐길 수 있도록 하십시오.

읽어주셔서 감사합니다!