cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update layout-of-source-files.rst

Browse Source 
An example of natspec comment.
This commit is contained in:
Mircea Moca 2016-08-05 14:16:14 +03:00 committed by GitHub
parent 3c93a22d47
commit 6846bb5dfd
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/layout-of-source-files.rst
View File

@ -157,3 +157,23 @@ 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
function.
In the following example we document the title of the contract, the explanation
for the two input parameters and two returned values.
::
/** @title Shape calculator.*/
contract shapeCalculator{
/**@dev Calculates a rectangle's surface and perimeter.
* @param w Width of the rectangle.
* @param h Height of the rectangle.
* @return s The calculated surface.
* @return p The calculated perimeter.
*/
function rectangle(uint w, uint h) returns (uint s, uint p){
s = w*h;
p = 2*(w+h);
}
}