diff options
| author | Ricardo Guilherme Schmidt <3esmit@gmail.com> | 2017-05-15 18:45:26 +0800 |
|---|---|---|
| committer | chriseth <chris@ethereum.org> | 2018-12-12 23:51:28 +0800 |
| commit | c7e09658010b231f4743039c9f91892341a64e15 (patch) | |
| tree | e6da2c3bc739c5671aca2c840f87d75c0d17ce1c /docs/layout-of-source-files.rst | |
| parent | 5e0c312dad2daaae155486397bfbd26d6d172718 (diff) | |
| download | dexon-solidity-c7e09658010b231f4743039c9f91892341a64e15.tar.gz dexon-solidity-c7e09658010b231f4743039c9f91892341a64e15.tar.zst dexon-solidity-c7e09658010b231f4743039c9f91892341a64e15.zip | |
Add NatSpec to Style-Guide
related to #2270
Diffstat (limited to 'docs/layout-of-source-files.rst')
| -rw-r--r-- | docs/layout-of-source-files.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst index ad84b200..fa36fc6a 100644 --- a/docs/layout-of-source-files.rst +++ b/docs/layout-of-source-files.rst @@ -267,7 +267,7 @@ Single-line comments (``//``) and multi-line comments (``/*...*/``) are possible (these are NEL, LS and PS), it will lead to a parser error. Additionally, there is another type of comment called a natspec comment, -for which the documentation is not yet written. They are written with a +which is detailed in the :ref:`style guide<natspec>`. They are written with a triple slash (``///``) or a double asterisk block(``/** ... */``) and they should be used directly above function declarations or statements. You can use `Doxygen <https://en.wikipedia.org/wiki/Doxygen>`_-style tags inside these comments to document |