Trong bài viết này, bạn sẽ tìm hiểu về Swift comment, tại sao và cách sử dụng chúng.
Chú thích là lời giải thích hoặc chú thích có thể đọc của lập trình viên trong mã nguồn của chương trình. Nó được trình biên dịch bỏ qua khi mã được biên dịch.
Nhận xét dành cho người đọc mã hiểu rõ hơn về mục đích và chức năng của chương trình. Nó có thể hữu ích khi làm việc trong nhóm để làm rõ mục đích của mã cho các thành viên khác trong nhóm hoặc khi chỉ làm việc, nó có thể hoạt động như một lời nhắc nhở sở hữu.
Bình luận Swift và các loại của nó
Nhanh chóng có hai loại nhận xét:
1. Nhận xét dòng đơn
Trong Swift, bất kỳ dòng nào bắt đầu bằng hai dấu gạch chéo //đều là một dòng chú thích. Mọi thứ bắt đầu bằng hai dấu gạch chéo //đều bị trình biên dịch bỏ qua.
Bạn có thể tìm thấy một ví dụ đơn giản ở đầu sân chơi:
//: Sân chơi - danh từ: nơi mọi người có thể chơi
Nó bắt đầu bằng hai dấu gạch chéo //và cung cấp lời giải thích có ý nghĩa về tệp là ": Playground - danh từ: nơi mọi người có thể chơi".
Ví dụ 1: Nhận xét dòng đơn
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Ví dụ trên chứa hai dòng chú thích:
// Chương trình mẫu // lưu trữ 3,14 trong biến số pi
2. Nhận xét nhiều dòng
Nếu nhận xét của bạn bao gồm nhiều dòng, bạn có thể đặt nó bên trong /*… */.
Nhận xét nhiều dòng bắt đầu bằng dấu gạch chéo lên phía trước, theo sau là dấu hoa thị ( /*) và kết thúc bằng dấu hoa thị, sau đó là dấu gạch chéo lên ( */). Mọi thứ ở giữa /*và */đều bị trình biên dịch nhanh chóng bỏ qua.
/ * Đây là một bình luận nhiều dòng. Sau khi bạn viết bình luận nhiều dòng, hãy thêm * theo sau bởi / để kết thúc nó * /
Ví dụ 2: Nhận xét nhiều dòng
/* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)
Ví dụ trên chứa một nhận xét nhiều dòng.
/ * Giá trị pi được mã hóa cứng có thể kém chính xác hơn. Vì vậy, bạn có thể tính toán bằng cách sử dụng các kiểu dữ liệu đã xây dựng để có giá trị chính xác hơn * /
Những điều cần ghi nhớ
Mặc dù nhận xét có ý nghĩa để hiểu rõ hơn về mục đích của đoạn mã được viết. Dưới đây là những điều bạn cần cân nhắc khi viết nó:
- Không đính kèm các chú thích bằng // trên nhiều dòng mặc dù nó hợp lệ và trình biên dịch bỏ qua các dòng đó. Thay vào đó, hãy đặt nó bên trong chú thích nhiều dòng
/*… */
Ví dụ:// Đây là một bình luận. // Sử dụng nó khi cần thiết và chính xác
Cách viết bình luận trên là đúng nhưng không được khuyến khích vì bạn cần viết bình luận nhiều dòng nếu bình luận lớn hơn một dòng. Cách tốt hơn để viết là sử dụng nhận xét nhiều dòng như:/ * Đây là một bình luận. Sử dụng nó khi cần thiết và chính xác * /
- Chú thích một dòng có thể được viết trong một dòng riêng biệt hoặc cùng với mã trong cùng một dòng. Tuy nhiên, nên sử dụng các bình luận trong một dòng riêng biệt.
Thí dụ:let pi = 3,14159 // lưu trữ 3,14 trong biến pi
Cách này để viết bình luận là hợp lệ. Nhưng tốt hơn là viết bình luận trong một dòng riêng biệt như:// lưu trữ 3,14 trong biến pi let pi = 3,14159
- Ngay cả khi bạn là một nhà phát triển duy nhất trong một nhóm và bạn là người duy nhất viết mã, nếu nó không được chú thích, bạn sẽ gặp khó khăn khi cố gắng tìm ra mục đích của nó trong chương trình. Vì vậy, hãy sử dụng nó một cách chính xác và cung cấp một mô tả có ý nghĩa.
- Làm cho bình luận rất đơn giản và ý nghĩa.
- Đừng viết những bình luận không cần thiết trên mã của bạn.
- Trong hầu hết các trường hợp, hãy sử dụng nhận xét để giải thích 'tại sao' thay vì 'làm thế nào'.
