Update Comments.md #40
Merged
Conversation
This file contains hidden or 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
* Add convention and rationale for the different types of single line and multi line comments in Swift. * Add new examples for each type of comment.
cy255
suggested changes
Jun 21, 2022
- Fix grammatical errors
cy255
approved these changes
Jul 18, 2022
| @@ -124,3 +124,61 @@ func loadLastCheckpoint() -> GameState? { | |||
| return loadedState | |||
| } | |||
| ``` | |||
|
|
|||
| ## Convention: Single line and multi line comment types | |||
There was a problem hiding this comment.
Something I started reviewing and apparently didn't publish: Should we explicitly mention that for non-public properties we recommend using /// as well? Or do we have no recommendation? In which case that would also be good to explicitly state?
This documentation is awesome, but the main remaining question that usually comes up is "what should I do for comments in code which don't directly translate to public API documentation?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add convention and rationale for the different types of single line and multi line comments in Swift.
Add new examples for each type of comment.