Hi 游客

更多精彩,请登录!

比特池塘 区块链技术 正文

Solidity 源文件结构

华胥
110 0 0
源文件中可以包含任意多个合约定义、导入指令和杂注指令。
% P% z2 Y8 ^& H. v' x/ D版本杂注
; P! l* b% W! k3 J为了避免未来被可能引入不兼容变更的编译器所编译,源文件可以(也应该)被所谓的版本 杂注pragma 所注解。 我们力图把这类变更做到尽可能小,特别是,我们需要以一种当修改语义时必须同步修改语法的方式引入变更,当然这有时候也难以做到。 因此,至少对含重大变更的版本,通读变更日志永远是好办法。 这些版本的版本号始终是0.x.0或者x.0.0的形式。0 s  M4 U- {6 q! d
版本杂注使用如下:
: }& c7 O4 |2 a! ^7 Epragma solidity ^0.4.0;
) h( t7 B) x7 @* N7 B% K# }7 f这样,源文件将既不允许低于 0.4.0 版本的编译器编译, 也不允许高于(包含) 0.5.0 版本的编译器编译(第二个条件因使用 ^ 被添加)。 这种做法的考虑是,编译器在 0.5.0 版本之前不会有重大变更,所以可确保源代码始终按预期被编译。 上面例子中不固定编译器的具体版本号,因此编译器的补丁版也可以使用。
) Q& [' C2 A, p( _可以使用更复杂的规则来指定编译器的版本,表达式遵循 npm 版本语义。" T* a6 H& \- V
注解! J' J6 W: q5 ~) j, f" o
Pragma 是 pragmatic information 的简称,微软 Visual C++ 文档 中译为杂注。 Solidity 中沿用 C ,C++ 等中的编译指令概念,用于告知编译器 如何 编译。 ——译者注
) x8 ?2 ^# @, `5 P+ M导入其他源文件
4 T) I% R+ {9 ^1 c5 J6 X语法与语义' J7 i2 m; M2 y1 c4 a
虽然 Solidity 不知道 “default export” 为何物, 但是 Solidity 所支持的导入语句,其语法同 JavaScript(从 ES6 起)非常类似。
8 t( A) h  m% S* L1 [: lES6 即 ECMAScript 6.0,ES6是 JavaScript 语言的下一代标准,已经在 2015 年 6 月正式发布。 ——译者注* x& d6 e2 S  q3 a! ^) x7 d- y
在全局层面上,可使用如下格式的导入语句:# u$ M6 i2 E+ ~/ f/ P! L
import "filename";
9 c% R" d( M' Y. j此语句将从 “filename” 中导入所有的全局符号到当前全局作用域中(不同于 ES6,Solidity 是向后兼容的)。
# N+ T% s; k8 s* }- a" M' fimport * as symbolName from "filename";# B9 i' \* l8 q6 J
…创建一个新的全局符号 symbolName,其成员均来自 “filename” 中全局符号。* a' N+ [4 `! _; v. t+ y0 z2 \
import {symbol1 as alias, symbol2} from "filename";
6 F4 y# i/ ?" x8 J9 `( K, P…创建新的全局符号 alias 和symbol2,分别从 "filename" 引用 symbol1 和 symbol2 。: J' r0 m& p) ^4 U# l
另一种语法不属于 ES6,但或许更简便:
, C1 F; a: y# B* M2 R+ Qimport "filename" as symbolName;' v; w' e9 b& [
这条语句等同于 import * as symbolName from "filename";。
% U* @' o+ o$ J' ~0 K路径& m9 N! M, Y' v1 P6 `2 i
上文中的 filename 总是会按路径来处理,以/作为目录分割符、以.标示当前目录、以..表示父目录。 当.或..后面跟随的字符是 /时,它们才能被当做当前目录或父目录。 只有路径以当前目录 . 或父目录..开头时,才能被视为相对路径。* A* B; A# K0 ~% w% [
用 import "./x" as x; 语句导入当前源文件同目录下的文件x。 如果用import "x" as x;代替,可能会引入不同的文件(在全局 include directory 中)。. p: Y- _3 g' ?) b# K$ {: D0 O9 k" d
最终导入哪个文件取决于编译器(见下文)到底是怎样解析路径的。 通常,目录层次不必严格映射到本地文件系统, 它也可以映射到能通过诸如 ipfs,http 或者 git 发现的资源。$ G( b* ?9 G, O
在实际的编译器中使用
8 j- q! z1 L* O7 \1 b. T' e当运行编译器时,它不仅能指定如何发现路径的第一个元素,还可指定路径前缀 重映射remapping。 例如,github.com/ethereum/dapp-bin/library 会被重映射到 /usr/local/dapp-bin/library , 此时编译器将从重映射位置读取文件。如果重映射到多个路径,优先尝试重映射路径最长的一个。 这允许将比如 “” 被映射到 "/usr/local/include/solidity" 来进行“回退重映射”。 同时,这些重映射可取决于上下文,允许你配置要导入的包,比如同一个库的不同版本。
: @% e3 m9 ~, fsolc:
0 }) d: A8 J9 y5 }' |& C对于 solc(命令行编译器),这些重映射以 context:prefix=target 形式的参数提供。 其中,context: 和 =target 部分是可选的(此时 target 默认为 prefix )。 所有重映射的值都是被编译过的常规文件(包括他们的依赖),这个机制完全是向后兼容的(只要文件名不包含 = 或 : ), 因此这不是一个破坏性修改。 在 content 目录或其子目录中的源码文件中,所有导入语句里以 prefix 开头的导入文件都将被用 target 替换prefix来重定向。
4 p# x9 V: N# W" {6 |举个例子,如果你已克隆github.com/ethereum/dapp-bin/ 到本地 /usr/local/dapp-bin , 可在源文件中使用:
2 y" Q( H" C% S# Q/ vimport "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping;7 {/ ?9 X1 {6 s1 _4 J- }& D. [: k
然后运行编译器:) h% [' G8 E$ `' M
solc github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ source.sol0 I! b8 a! l* |' ]1 |3 n
举个更复杂的例子,假设你依赖了一些使用了非常旧版本的 dapp-bin 的模块。 旧版本的 dapp-bin 已经被 checkout 到/usr/local/dapp-bin_old,此时你可使用:1 w, d& ^4 f1 b9 E0 F+ g  a5 j5 J
solc module1:github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ \
& v5 v" t- R" o2 g. {- [; bmodule2:github.com/ethereum/dapp-bin/=/usr/local/dapp-bin_old/ \
0 Y; d* P/ ]) }  G, ?6 }source.sol/ h1 n- c* o( `# w6 U
这样,module2中的所有导入都指向旧版本,而module1中的导入则获取新版本。9 ^# _4 T$ L  B7 c
注意, solc 只允许包含来自特定目录的文件:它们必须位于显式地指定的源文件目录(或子目录)中,或者重映射的目标目录(或子目录)中。 如果你想直接用绝对路径来包含文件,只需添加重映射 =/。
4 m" }6 @# y2 ]; y1 p: `7 s7 K如果有多个重映射指向一个有效文件,那么具有最长公共前缀的重映射会被选用。  H- ?9 R3 H" F+ @. x
Remix:
/ [- w! D, }! @6 ?; k% R( {Remix 提供一个为 github 源代码平台的自动重映射,它将通过网络自动获取文件: 比如,你可以使用 import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping; 导入一个 map 迭代器。/ g* k/ ^0 Z" M5 G" w& q1 ~5 ?
未来, Remix 可能支持其他源代码平台。
; p2 [7 f5 P) ?1 T8 X5 ^4 X注释; W! K9 N& H6 i  u
可以使用单行注释(//)和多行注释(/*...*/)
: K" G% q+ B$ b) g. |5 \// 这是一个单行注释。
' V2 s9 s2 u9 N: i( Z/ B/*2 ]) k0 [- @+ e" ~9 I. b0 }
这是一个  M& W8 K! ^. F5 j) `
多行注释。
$ a/ V9 s+ ~! P# S$ P, M# X# t*/
* a  m3 f, V6 ?% d" _" U此外,有另一种注释称为 natspec 注释,其文档还尚未编写。 它们是用三个反斜杠(///)或双星号开头的块(/** … */)书写,它们应该直接在函数声明或语句上使用。 可在注释中使用 Doxygen 样式的标签来文档化函数、 标注形式校验通过的条件,和提供一个当用户试图调用一个函数时显示给用户的 确认文本。
+ l7 C: G' H  r& s2 b4 z: Z1 s在下面的例子中,我们记录了合约的标题、两个入参和两个返回值的说明:  {9 m1 b$ ]+ W& s7 @$ A+ Z
pragma solidity ^0.4.0;- P- B, V  M8 i6 }) \, |
/** @title 形状计算器。 */
3 S1 X0 R+ Q1 l. a; kcontract shapeCalculator {3 T+ n  B3 g2 U  M4 T7 U
    /** @dev 求矩形表明面积与周长。
: h5 ?: O5 B6 j6 U: ]- w5 D$ r    * @param w 矩形宽度。
5 t, \9 ?" `8 j3 ^+ h( K5 G    * @param h 矩形高度。6 T& k# i- t$ D* S6 I9 L
    * @return s 求得表面积。
- E( A- H$ e2 x$ R9 Z    * @return p 求得周长。
* B' ]- ~1 H. |    */3 z! P: W2 Y& q7 a& }! M% H
    function rectangle(uint w, uint h) returns (uint s, uint p) {
2 K; t1 d" b, b: E/ w9 l        s = w * h;  p6 k+ x# _( E
        p = 2 * (w + h);
+ L2 f( R9 s) u    }
# P' D" G3 a4 r$ w, I}/ s$ h0 [) i$ v+ e& _& I2 q- E; I
? Copyright 2016-2017, Ethereum. Revision c51c7506.9 I0 x  b  h- S/ j2 Q
https://github.com/etherchina/solidity-doc-cn/blob/develop/layout-of-source-files.rst
BitMere.com 比特池塘系信息发布平台,比特池塘仅提供信息存储空间服务。
声明:该文观点仅代表作者本人,本文不代表比特池塘立场,且不构成建议,请谨慎对待。
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

成为第一个吐槽的人

华胥 初中生
  • 粉丝

    0

  • 关注

    0

  • 主题

    13