diff options
author | Denton Liu <liu.denton+github@gmail.com> | 2016-05-18 23:35:00 +0800 |
---|---|---|
committer | Denton Liu <liu.denton+github@gmail.com> | 2016-05-18 23:35:28 +0800 |
commit | 18fb63167b2923a7e96255893f5357d5186cd23f (patch) | |
tree | 454930c2f2acb135c6b22a8214c5df1f29541acb /docs/layout-of-source-files.rst | |
parent | d70ae38e9241bc9982e04d2cc16d6df18f2ae015 (diff) | |
download | dexon-solidity-18fb63167b2923a7e96255893f5357d5186cd23f.tar.gz dexon-solidity-18fb63167b2923a7e96255893f5357d5186cd23f.tar.zst dexon-solidity-18fb63167b2923a7e96255893f5357d5186cd23f.zip |
Removed trailing whitespace
Diffstat (limited to 'docs/layout-of-source-files.rst')
-rw-r--r-- | docs/layout-of-source-files.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst index 7033a062..5b81b0e8 100644 --- a/docs/layout-of-source-files.rst +++ b/docs/layout-of-source-files.rst @@ -21,7 +21,7 @@ At a global level, you can use import statements of the following form: import "filename"; -...will import all global symbols from "filename" (and symbols imported there) into the +...will import all global symbols from "filename" (and symbols imported there) into the current global scope (different than in ES6 but backwards-compatible for Solidity). :: @@ -122,18 +122,18 @@ Single-line comments (`//`) and multi-line comments (`/*...*/`) are possible. :: // This is a single-line comment. - + /* - This is a + This is a multi-line comment. */ - + Additionally, there is another type of comment called a natspec comment, for which the documentation is not yet written. They are written with a triple slash (`///`) or a double asterisk block(`/** ... */`) and -they should be used directly above function declarations or statements. +they should be used directly above function declarations or statements. You can use Doxygen-style tags inside these comments to document -functions, annotate conditions for formal verification, and provide a +functions, annotate conditions for formal verification, and provide a **confirmation text** which is shown to users when they attempt to invoke a function. |