diff options
| author | ssonicblue <ssonicblue@users.noreply.github.com> | 2016-05-01 11:41:49 +0800 |
|---|---|---|
| committer | ssonicblue <ssonicblue@users.noreply.github.com> | 2016-05-01 11:41:49 +0800 |
| commit | 943e27a1c33ecad88aee662af6c35dcd088a22d8 (patch) | |
| tree | fcb861c6afc2c15f9186b0d834dd2b0637a71381 /docs/layout-of-source-files.rst | |
| parent | 5a1f892361ec36fd3a7fd66b571e01af9f0e0385 (diff) | |
| download | dexon-solidity-943e27a1c33ecad88aee662af6c35dcd088a22d8.tar.gz dexon-solidity-943e27a1c33ecad88aee662af6c35dcd088a22d8.tar.zst dexon-solidity-943e27a1c33ecad88aee662af6c35dcd088a22d8.zip | |
Minor grammatical edit
Diffstat (limited to 'docs/layout-of-source-files.rst')
| -rw-r--r-- | docs/layout-of-source-files.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst index 76c13ae3..7033a062 100644 --- a/docs/layout-of-source-files.rst +++ b/docs/layout-of-source-files.rst @@ -131,8 +131,8 @@ Single-line comments (`//`) and multi-line comments (`/*...*/`) are possible. 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(`/** ... */`). -They should be used directly above function declarations or statements. +triple slash (`///`) or a double asterisk block(`/** ... */`) and +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 **confirmation text** which is shown to users when they attempt to invoke a |