代码注释

支持类似 Java、C++ 风格注释

• 行注释: // 之后到行尾的文本
• 块注释: /* 与 */ 之间的代码

示例

pragma solidity ^0.8.4;

// 这是行注释
contract HelloWorld {
    /*
    这是块注释
    这是块注释
    这是块注释
    这是块注释
    这是块注释
    */
    function sayHello() public pure returns (string memory) {
        return "Hello World!";
    }
}

SPDX 语法

从 Solidity 0.6.8 开始，该版本及其以后版本引入了 SPDX 许可证，使用该许可证可以让合约代码更加透明和可读。

如果源代码未包含 SPDX 许可证说明，当进行编译时，编译器会发出警告信息，提醒代码编写者需要添加许可证说明。

通常在Solidity代码文件的开头添加注释

// SPDX-License-Identifier: (license)

其中(license)代表使用的具体许可证，比如常用的 MIT、Apache 等。