Solidity 源文件结构
华胥
发表于 2022-12-26 21:45:50
91
0
0
版本杂注! w; W0 p+ @. w4 a0 n% T! S. c
为了避免未来被可能引入不兼容变更的编译器所编译,源文件可以(也应该)被所谓的版本 杂注pragma 所注解。 我们力图把这类变更做到尽可能小,特别是,我们需要以一种当修改语义时必须同步修改语法的方式引入变更,当然这有时候也难以做到。 因此,至少对含重大变更的版本,通读变更日志永远是好办法。 这些版本的版本号始终是0.x.0或者x.0.0的形式。
版本杂注使用如下:
pragma solidity ^0.4.0;
这样,源文件将既不允许低于 0.4.0 版本的编译器编译, 也不允许高于(包含) 0.5.0 版本的编译器编译(第二个条件因使用 ^ 被添加)。 这种做法的考虑是,编译器在 0.5.0 版本之前不会有重大变更,所以可确保源代码始终按预期被编译。 上面例子中不固定编译器的具体版本号,因此编译器的补丁版也可以使用。7 E7 O3 t" G% X; a ^+ ]/ k
可以使用更复杂的规则来指定编译器的版本,表达式遵循 npm 版本语义。
注解
Pragma 是 pragmatic information 的简称,微软 Visual C++ 文档 中译为杂注。 Solidity 中沿用 C ,C++ 等中的编译指令概念,用于告知编译器 如何 编译。 ——译者注
导入其他源文件: j& {5 ~8 M3 c
语法与语义
虽然 Solidity 不知道 “default export” 为何物, 但是 Solidity 所支持的导入语句,其语法同 JavaScript(从 ES6 起)非常类似。6 |8 i# L; [! D2 @" `: t/ @
ES6 即 ECMAScript 6.0,ES6是 JavaScript 语言的下一代标准,已经在 2015 年 6 月正式发布。 ——译者注6 ^' d0 M( C2 G5 k5 s7 h
在全局层面上,可使用如下格式的导入语句:
import "filename";
此语句将从 “filename” 中导入所有的全局符号到当前全局作用域中(不同于 ES6,Solidity 是向后兼容的)。" ^5 c$ q9 x$ r2 v6 s2 w) `& E6 U: B
import * as symbolName from "filename";
…创建一个新的全局符号 symbolName,其成员均来自 “filename” 中全局符号。
import {symbol1 as alias, symbol2} from "filename";
…创建新的全局符号 alias 和symbol2,分别从 "filename" 引用 symbol1 和 symbol2 。
另一种语法不属于 ES6,但或许更简便:# [" r/ y% B6 b H
import "filename" as symbolName;9 w1 ^% `8 L+ b; L/ a, t
这条语句等同于 import * as symbolName from "filename";。
路径: Z% c, x' e* G0 p
上文中的 filename 总是会按路径来处理,以/作为目录分割符、以.标示当前目录、以..表示父目录。 当.或..后面跟随的字符是 /时,它们才能被当做当前目录或父目录。 只有路径以当前目录 . 或父目录..开头时,才能被视为相对路径。
用 import "./x" as x; 语句导入当前源文件同目录下的文件x。 如果用import "x" as x;代替,可能会引入不同的文件(在全局 include directory 中)。7 [/ B( \, R" ]9 M( @! j
最终导入哪个文件取决于编译器(见下文)到底是怎样解析路径的。 通常,目录层次不必严格映射到本地文件系统, 它也可以映射到能通过诸如 ipfs,http 或者 git 发现的资源。$ o7 S3 b4 f2 ]
在实际的编译器中使用1 p6 B! i+ n- `2 @8 q( ]
当运行编译器时,它不仅能指定如何发现路径的第一个元素,还可指定路径前缀 重映射remapping。 例如,github.com/ethereum/dapp-bin/library 会被重映射到 /usr/local/dapp-bin/library , 此时编译器将从重映射位置读取文件。如果重映射到多个路径,优先尝试重映射路径最长的一个。 这允许将比如 “” 被映射到 "/usr/local/include/solidity" 来进行“回退重映射”。 同时,这些重映射可取决于上下文,允许你配置要导入的包,比如同一个库的不同版本。, n# m9 v! q/ I
solc:
对于 solc(命令行编译器),这些重映射以 context:prefix=target 形式的参数提供。 其中,context: 和 =target 部分是可选的(此时 target 默认为 prefix )。 所有重映射的值都是被编译过的常规文件(包括他们的依赖),这个机制完全是向后兼容的(只要文件名不包含 = 或 : ), 因此这不是一个破坏性修改。 在 content 目录或其子目录中的源码文件中,所有导入语句里以 prefix 开头的导入文件都将被用 target 替换prefix来重定向。- y; K; i% \& |/ Y
举个例子,如果你已克隆github.com/ethereum/dapp-bin/ 到本地 /usr/local/dapp-bin , 可在源文件中使用:
import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping;- h! [, p$ B I* F+ `
然后运行编译器:- `! B0 |7 t5 b( ?5 g
solc github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ source.sol, C' c' E8 Z# c# Y
举个更复杂的例子,假设你依赖了一些使用了非常旧版本的 dapp-bin 的模块。 旧版本的 dapp-bin 已经被 checkout 到/usr/local/dapp-bin_old,此时你可使用:
solc module1:github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ \- `+ o2 q8 Q9 C0 Y, n# g1 O
module2:github.com/ethereum/dapp-bin/=/usr/local/dapp-bin_old/ \
source.sol* I( B9 f; N& H
这样,module2中的所有导入都指向旧版本,而module1中的导入则获取新版本。0 |& b/ \& X9 j4 M# f& [
注意, solc 只允许包含来自特定目录的文件:它们必须位于显式地指定的源文件目录(或子目录)中,或者重映射的目标目录(或子目录)中。 如果你想直接用绝对路径来包含文件,只需添加重映射 =/。
如果有多个重映射指向一个有效文件,那么具有最长公共前缀的重映射会被选用。! P1 |7 f) O p3 Z% B3 u" J( W
Remix:
Remix 提供一个为 github 源代码平台的自动重映射,它将通过网络自动获取文件: 比如,你可以使用 import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping; 导入一个 map 迭代器。 H. [: r3 ~. B9 v; t6 {4 [
未来, Remix 可能支持其他源代码平台。
注释/ `$ q+ w& z) y3 d
可以使用单行注释(//)和多行注释(/*...*/)5 v; s0 F- ^4 l/ Y: q: X7 x# K1 E
// 这是一个单行注释。8 J) d- }5 k" X4 D+ U
/*
这是一个$ h; |6 O) ?) v8 W# t
多行注释。
*/. L; H" w/ T8 _) M# g7 a7 @
此外,有另一种注释称为 natspec 注释,其文档还尚未编写。 它们是用三个反斜杠(///)或双星号开头的块(/** … */)书写,它们应该直接在函数声明或语句上使用。 可在注释中使用 Doxygen 样式的标签来文档化函数、 标注形式校验通过的条件,和提供一个当用户试图调用一个函数时显示给用户的 确认文本。
在下面的例子中,我们记录了合约的标题、两个入参和两个返回值的说明:
pragma solidity ^0.4.0;
/** @title 形状计算器。 */
contract shapeCalculator {4 L6 b2 y6 N! l; f6 O# f
/** @dev 求矩形表明面积与周长。
* @param w 矩形宽度。1 v& ?& V$ k7 z0 ?
* @param h 矩形高度。
* @return s 求得表面积。3 O) q V5 }2 e" g+ g( d9 m
* @return p 求得周长。
*/. V3 Z5 T+ N: ^
function rectangle(uint w, uint h) returns (uint s, uint p) {
s = w * h;
p = 2 * (w + h);5 x1 m- q2 w, i+ o9 [
}
}
? Copyright 2016-2017, Ethereum. Revision c51c7506.
https://github.com/etherchina/solidity-doc-cn/blob/develop/layout-of-source-files.rst
成为第一个吐槽的人