Hi 游客

更多精彩,请登录!

比特池塘 区块链技术 正文

Solidity 源文件结构

华胥
73 0 0
源文件中可以包含任意多个合约定义、导入指令和杂注指令。" ]7 k9 w2 `* \( N
版本杂注
& x* Y, n* @1 G* w2 @为了避免未来被可能引入不兼容变更的编译器所编译,源文件可以(也应该)被所谓的版本 杂注pragma 所注解。 我们力图把这类变更做到尽可能小,特别是,我们需要以一种当修改语义时必须同步修改语法的方式引入变更,当然这有时候也难以做到。 因此,至少对含重大变更的版本,通读变更日志永远是好办法。 这些版本的版本号始终是0.x.0或者x.0.0的形式。
- e' H9 |2 c+ ?2 v版本杂注使用如下:1 Q6 P- D: c5 f# ^
pragma solidity ^0.4.0;
: |+ y' {! h" I# ?: j/ q1 @8 N6 q这样,源文件将既不允许低于 0.4.0 版本的编译器编译, 也不允许高于(包含) 0.5.0 版本的编译器编译(第二个条件因使用 ^ 被添加)。 这种做法的考虑是,编译器在 0.5.0 版本之前不会有重大变更,所以可确保源代码始终按预期被编译。 上面例子中不固定编译器的具体版本号,因此编译器的补丁版也可以使用。
4 Y* f; l+ Q7 H8 V! Q& ]+ t* f可以使用更复杂的规则来指定编译器的版本,表达式遵循 npm 版本语义。' U, {7 _; q( |# C
注解
. W  C8 P% _: |9 P5 jPragma 是 pragmatic information 的简称,微软 Visual C++ 文档 中译为杂注。 Solidity 中沿用 C ,C++ 等中的编译指令概念,用于告知编译器 如何 编译。 ——译者注
4 D2 V9 T: E) N0 D# K导入其他源文件
9 ]+ Y' d5 ~. a% w$ C1 U语法与语义
0 q  d6 v1 |# o) j% |虽然 Solidity 不知道 “default export” 为何物, 但是 Solidity 所支持的导入语句,其语法同 JavaScript(从 ES6 起)非常类似。
' E. P0 ^3 I+ C& z9 H8 }0 x3 uES6 即 ECMAScript 6.0,ES6是 JavaScript 语言的下一代标准,已经在 2015 年 6 月正式发布。 ——译者注7 @/ H5 p, F$ W
在全局层面上,可使用如下格式的导入语句:$ O* e" u) b! o( L
import "filename";
9 r6 X/ J8 m6 y  V* Q此语句将从 “filename” 中导入所有的全局符号到当前全局作用域中(不同于 ES6,Solidity 是向后兼容的)。& [( ^2 i+ ]8 P; g: h
import * as symbolName from "filename";% T" F1 ?" t' Z' M* b+ n
…创建一个新的全局符号 symbolName,其成员均来自 “filename” 中全局符号。
% X' u+ I& P4 `: j& L% ~: F7 A7 l0 Iimport {symbol1 as alias, symbol2} from "filename";: l; a1 f6 A- n* g9 I4 j% f4 S# L
…创建新的全局符号 alias 和symbol2,分别从 "filename" 引用 symbol1 和 symbol2 。
* G$ j( M+ @+ A  S3 C* f- {, [另一种语法不属于 ES6,但或许更简便:, V7 f* y; k7 R# {# h- E
import "filename" as symbolName;
/ Z0 l1 t/ e2 F. f这条语句等同于 import * as symbolName from "filename";。
* @6 O1 P5 q8 ?0 `0 ]# N+ @3 V& {' L路径
8 }/ `2 h, b; c" Y; B& X# v0 Z上文中的 filename 总是会按路径来处理,以/作为目录分割符、以.标示当前目录、以..表示父目录。 当.或..后面跟随的字符是 /时,它们才能被当做当前目录或父目录。 只有路径以当前目录 . 或父目录..开头时,才能被视为相对路径。& M8 C6 u% e: l5 n8 u
用 import "./x" as x; 语句导入当前源文件同目录下的文件x。 如果用import "x" as x;代替,可能会引入不同的文件(在全局 include directory 中)。' ?8 H# U$ ~, l
最终导入哪个文件取决于编译器(见下文)到底是怎样解析路径的。 通常,目录层次不必严格映射到本地文件系统, 它也可以映射到能通过诸如 ipfs,http 或者 git 发现的资源。% y' {  [( r( Q7 `3 k* B
在实际的编译器中使用
7 w, h+ Y" \& a当运行编译器时,它不仅能指定如何发现路径的第一个元素,还可指定路径前缀 重映射remapping。 例如,github.com/ethereum/dapp-bin/library 会被重映射到 /usr/local/dapp-bin/library , 此时编译器将从重映射位置读取文件。如果重映射到多个路径,优先尝试重映射路径最长的一个。 这允许将比如 “” 被映射到 "/usr/local/include/solidity" 来进行“回退重映射”。 同时,这些重映射可取决于上下文,允许你配置要导入的包,比如同一个库的不同版本。
6 p. r$ d: P" l" Y" Qsolc:
$ z; x% N3 ]+ ~. t( F% ^* |对于 solc(命令行编译器),这些重映射以 context:prefix=target 形式的参数提供。 其中,context: 和 =target 部分是可选的(此时 target 默认为 prefix )。 所有重映射的值都是被编译过的常规文件(包括他们的依赖),这个机制完全是向后兼容的(只要文件名不包含 = 或 : ), 因此这不是一个破坏性修改。 在 content 目录或其子目录中的源码文件中,所有导入语句里以 prefix 开头的导入文件都将被用 target 替换prefix来重定向。
" ?3 t6 r- J0 z+ C8 D+ w举个例子,如果你已克隆github.com/ethereum/dapp-bin/ 到本地 /usr/local/dapp-bin , 可在源文件中使用:' t, x& @  \6 C3 r! f% `7 K
import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping;8 h" b, a  Y  P. {& y* z# p6 a, o
然后运行编译器:* @9 f* o" Z; {" B
solc github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ source.sol' N8 k+ z( i# e0 W) K
举个更复杂的例子,假设你依赖了一些使用了非常旧版本的 dapp-bin 的模块。 旧版本的 dapp-bin 已经被 checkout 到/usr/local/dapp-bin_old,此时你可使用:$ ?8 D/ Z9 a, k0 Q2 h) ?
solc module1:github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ \1 y( w( O. K7 b. P
module2:github.com/ethereum/dapp-bin/=/usr/local/dapp-bin_old/ \6 F8 h; N) L: j" i, K
source.sol- w8 f2 A! E2 B; l, O8 f
这样,module2中的所有导入都指向旧版本,而module1中的导入则获取新版本。
# b. U7 {- u, F' O: B" A1 @$ ?7 Q注意, solc 只允许包含来自特定目录的文件:它们必须位于显式地指定的源文件目录(或子目录)中,或者重映射的目标目录(或子目录)中。 如果你想直接用绝对路径来包含文件,只需添加重映射 =/。
* x! Y9 C6 u3 \# L如果有多个重映射指向一个有效文件,那么具有最长公共前缀的重映射会被选用。$ q1 {' i0 k7 e) i6 M
Remix:' R6 H+ d7 b# a' w: X& t6 Q; u
Remix 提供一个为 github 源代码平台的自动重映射,它将通过网络自动获取文件: 比如,你可以使用 import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping; 导入一个 map 迭代器。
) S4 e5 A+ \  D' Q, k未来, Remix 可能支持其他源代码平台。
/ s4 `/ O1 B9 ~* R+ r注释. x+ L) C) x. L0 O# U: k6 {) g2 Y
可以使用单行注释(//)和多行注释(/*...*/)3 P( ^1 g6 b9 [, R/ f& s; C
// 这是一个单行注释。/ {$ n/ _% C* A, u3 p5 J
/*& P3 i$ _3 ]5 _5 B* c, Q6 e$ {: J9 A
这是一个
# ?5 Q1 N/ n8 ]/ h, U' [多行注释。
; L+ J# \0 h# u7 B3 ?*/1 p' C' y% Z! q/ P: [
此外,有另一种注释称为 natspec 注释,其文档还尚未编写。 它们是用三个反斜杠(///)或双星号开头的块(/** … */)书写,它们应该直接在函数声明或语句上使用。 可在注释中使用 Doxygen 样式的标签来文档化函数、 标注形式校验通过的条件,和提供一个当用户试图调用一个函数时显示给用户的 确认文本。! K; `5 r& |  ]! W( l
在下面的例子中,我们记录了合约的标题、两个入参和两个返回值的说明:% l6 ]+ \. K8 G9 T
pragma solidity ^0.4.0;
- B9 ]3 M$ X5 d+ b1 H/** @title 形状计算器。 */) v$ j6 h. \8 e, g8 Y; D
contract shapeCalculator {: V, y, x: y( k: p
    /** @dev 求矩形表明面积与周长。+ |+ c/ n; j- E1 X" j2 H; h$ o; c
    * @param w 矩形宽度。
! u' j5 a% ^& L* r    * @param h 矩形高度。
6 i0 Z2 V4 b* u$ o    * @return s 求得表面积。0 a5 \6 ?7 b7 i0 S& w
    * @return p 求得周长。
7 t. S$ b& F5 ^% I, `' x) |6 l2 T    */- U) `+ ^; l; T! D+ J6 `
    function rectangle(uint w, uint h) returns (uint s, uint p) {
1 w4 d- l  ?; P  L) u2 g% w        s = w * h;
8 }* v2 m7 \( i8 X% Q        p = 2 * (w + h);
! I2 R! Y; u5 h: f$ i% H( d! H    }/ [, m% T8 H, m/ M
}7 Y1 v2 u3 t- X# d  W9 F1 y
? Copyright 2016-2017, Ethereum. Revision c51c7506.
7 _4 G$ o8 I# ghttps://github.com/etherchina/solidity-doc-cn/blob/develop/layout-of-source-files.rst
BitMere.com 比特池塘系信息发布平台,比特池塘仅提供信息存储空间服务。
声明:该文观点仅代表作者本人,本文不代表比特池塘立场,且不构成建议,请谨慎对待。
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

成为第一个吐槽的人

华胥 初中生
  • 粉丝

    0

  • 关注

    0

  • 主题

    13