-
-
Save sturdysturge/fc9c47284d9e482b5301f9a6cf518bd0 to your computer and use it in GitHub Desktop.
Documentation comments
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
A summary of what the function does | |
A longer description of what the function does | |
- Author: | |
Rob Sturgeon | |
- Returns: | |
The sum of the two numbers | |
- Throws: | |
If the function threw an error, it would be explained here | |
- parameters: | |
- number1: The first integer | |
- number2: The second integer | |
- Important: | |
A reminder of something you shouldn't forget | |
- Version: | |
1.0 | |
*/ | |
func sum(number1: Int, number2: Int) -> Int { | |
return number1 + number2 | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment