Skip to content

Instantly share code, notes, and snippets.

@sturdysturge
Created December 28, 2020 21:42
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save sturdysturge/fc9c47284d9e482b5301f9a6cf518bd0 to your computer and use it in GitHub Desktop.
Save sturdysturge/fc9c47284d9e482b5301f9a6cf518bd0 to your computer and use it in GitHub Desktop.
Documentation comments
/**
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