Comments Solidity
Viết chú thích trong ngôn ngữ lập trình SOLIDITY
Cú pháp cho bình luận
Bình luận trong Solidity cũng giống như JavaScript.
// Đây là một một dòng nhận xét. Nó là một ghi chú cho bản thân (hoặc cho người khác)
Chỉ cần thêm đôi // vào bất kỳ đâu và bạn đang bình luận. Nó rất dễ dàng mà bạn nên làm nó mọi lúc.
Nhưng tôi nghe bạn - đôi khi một dòng là không đủ.
contract TuHocSolidityCom {
/* Đây là một bình luận nhiều dòng. Tôi muốn cảm ơn tất cả các bạn
những người đã dành thời gian của bạn để thử khóa học lập trình này.
Tôi biết nó miễn phí cho tất cả các bạn, và nó sẽ miễn phí
mãi mãi, nhưng chúng tôi vẫn làm tất cả sức mình để làm
khoá học này tốt nhất có thể.
Biết rằng đây vẫn là bước khởi đầu của sự phát triển Blockchain.
Chúng tôi đã tiến rất xa nhưng có rất nhiều cách để thực hiện nó.
*/
}
Đặc biệt, bạn nên chú thích code của mình để giải thích chức năng hoạt động của một hàm trong hợp đồng của bạn. Bằng cách này, một nhà phát triển khác (hoặc chính bạn, sau 6 tháng gián đoạn từ một dự án!) Có thể nhanh chóng đọc và hiểu những gì code của bạn làm mà không cần phải đọc mã nguồn.
Tiêu chuẩn trong cộng đồng Solidity là sử dụng một định dạng có tên là natspec, trông giống như sau:
/// @title A contract for basic math operations
/// @author H4XF13LD MORRIS 💯💯😎💯💯
/// @notice For now, this contract just adds a multiply function
contract Math {
/// @notice Multiplies 2 numbers together
/// @param x the first uint.
/// @param y the second uint.
/// @return z the product of (x * y)
/// @dev This function does not currently check for overflows
function multiply(uint x, uint y) returns (uint z) {
// This is just a normal comment, and won't get picked up by natspec
z = x * y;
}
}
@title là tiêu đề
@author là tác giả của hàm
@notice giải thích cho người dùng những gì hợp đồng / chức năng thực hiện.
@dev là để giải thích các chi tiết bổ sung cho các nhà phát triển.
@param dùng để mô tả mỗi tham số của hàm dùng để làm gì.
@return dùng để mô tả giá trị trả về của hàm.
BÀI TIẾP THEO: BÀI SỐ 43
HỌC TỪ ĐẦU: BÀI SỐ 1