Skip to content

Instantly share code, notes, and snippets.

@bengidev

bengidev/swift_comment_snippet

Created June 13, 2023 08:49
Show Gist options
  • Save bengidev/c35f64805c2ecab7bd4ab0410cdd7ecc to your computer and use it in GitHub Desktop.
Save bengidev/c35f64805c2ecab7bd4ab0410cdd7ecc to your computer and use it in GitHub Desktop.
Download ZIP
Create a code comment snippet to simplify commenting your code.
Raw
swift_comment_snippet
/// <#Summay text for documentation#>.
///
/// <#Discussion text for documentation#>.
///
/// For example:
/// ```
/// // <#Example code if any#>
/// ```
///
/// - Parameters:
/// - <#parameterName#>: <#Description#>.
///
/// - Returns: <#Return values#>.
/// - Throws: <#Throw possible errors#>.
/// - Warning: <#Warning if any#>.
///
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment