Nhận xét trong Ruby là gì?
Nhận xét của Ruby bổ sung thông tin vào mã của bạn có thể hữu ích cho bạn hoặc các nhà phát triển khác.
Loại bình luận phổ biến nhất là bình luận một dòng.
Đây là cú pháp :
# I like apples & oranges
Lưu ý ba điều :
- Nhận xét bắt đầu bằng một pound (
#) biểu tượng - Chúng tôi đặt một khoảng trống giữa nội dung của nhận xét và phần đầu của nhận xét để giúp bạn đọc dễ dàng hơn
- Mọi thứ bên trong nhận xét không được hiểu là mã, ngay cả khi nó trông giống như mã. Điều này có nghĩa là bạn có thể tạm thời bình luận mã để tắt nó.
Bạn có thể sử dụng các nhận xét này theo cách riêng của chúng hoặc nội dòng ở cuối dòng mã.
Như thế này :
[].size # get array size
Có các loại nhận xét khác không?
Có, có những bình luận ma thuật, bình luận nhiều dòng &bình luận ERB.
Hãy cùng khám phá những điều đó!
Cách sử dụng chú thích nhiều dòng trong Ruby
Trong Ruby, chúng tôi thực hiện các nhận xét nhiều dòng với các nhận xét thông thường, một dòng.
Một số người gọi những điều này là "chặn nhận xét".
Đây là một ví dụ :
# aaa # bbb # ccc
Đó chính xác là cách nhận xét một khối mã trong ruby.
Trình chỉnh sửa mã hiện đại cho phép bạn chọn một khối mã và nhận xét tất cả bằng cách sử dụng phím tắt, vì vậy không cần thêm nỗ lực nào.
Nhưng có một cú pháp nhận xét nhiều dòng đặc biệt.
Có vẻ như thế này :
=begin This is a comment... a b c =end
Không ai sử dụng cú pháp này…
Nó xấu xí và bạn thậm chí không thể sử dụng nó bên trong bất kỳ thứ gì được thụt vào (như một phương thức), nhưng thật tốt khi biết nó tồn tại nếu bạn tìm thấy nó trong tự nhiên.
Nhận xét của SheBang
Một shebang (#! ) là một loại nhận xét đặc biệt cho biết trình bao Unix (như bash) cách diễn giải tệp này.
Khi bạn thêm nhận xét này ở đầu tệp của mình…
Bạn sẽ có thể chạy các tệp Ruby của mình dưới dạng tệp thực thi, giả sử chúng có quyền phù hợp để làm điều đó.
Đây là những gì một nhận xét tập thể trông giống như:
#!/usr/bin/env ruby
Điều này cũng cho phép bạn đặt các tùy chọn dòng lệnh cụ thể, như tùy chọn cảnh báo.
Ví dụ :
#!/usr/bin/env ruby -w
Mỗi khi bạn chạy mã này, mã sẽ chạy với các tùy chọn này, vì vậy bạn không phải chuyển chúng theo cách thủ công.
Cách sử dụng bình luận ma thuật
Một nhận xét ma thuật thay đổi hành vi của trình thông dịch Ruby theo một cách nào đó.
Ví dụ :
frozen_string_literals nhận xét sẽ làm cho chuỗi của bạn bị đóng băng theo mặc định.
Có vẻ như thế này :
# frozen_string_literal: true
Một nhận xét kỳ diệu khác cho phép bạn thay đổi mã hóa của tệp.
Đây là một ví dụ :
# encoding: utf-8
Đây là một điều thú vị, nhận xét warning_indent :
# warn_indent: true
Điều này sẽ hiển thị cảnh báo bất cứ khi nào thụt lề của bạn sai.
Ví dụ :
def comments end
Kết quả nào dẫn đến :
warning: mismatched indentations at 'end' with 'def' at 3
Nhận xét ERB
Nếu bạn đang sử dụng ERB cho các chế độ xem Rails của mình và bạn cần thêm nhận xét…
Sau đó, bạn có thể sử dụng cú pháp này :
<%# ERB comment %>
Tôi không phải là người thích điều này vì tôi tin rằng bạn nên giữ hầu hết logic của mình ngoài quan điểm của mình để bạn không cần bất kỳ nhận xét nào.
Tìm cách tắt một số mã để gỡ lỗi ?
Sau đó, xóa mã đó và tin cậy git hoặc bất kỳ hệ thống kiểm soát phiên bản nào bạn đang sử dụng.
Tóm tắt
Bạn đã biết về các loại nhận xét Ruby khác nhau, bao gồm cả các nhận xét thông thường (# ), bình luận shebang (#! ) &nhận xét ma thuật (# frozen_string_literal: true )!
Nếu bạn thấy bài viết này hữu ích, vui lòng chia sẻ nó với bạn bè để họ cũng có thể tận hưởng điều này.
Cảm ơn vì đã đọc!