Some thing that looks like a comment but isn't a comment

General Discussion
1

I know comments are written like // This is a comment but I recently ran into this /// what is this that makes the text turn into something like plain text and greys out the triple-forward slash.

Image:

Screen Shot 2020-04-12 at 10.44.21
Screen Shot 2020-04-12 at 10.44.211440×900 67.5 KB

I am seriously confused.

Ben

2

It’s a way to include Markdown-formatted documentation in your code. Use of /// for inline comments or /** ... */ for block comments indicates the included text is formatted as Markdown. Your documentation will show just like Apple’s does when you option-click on a method or whatever.

There is a lot you can do with this. For more info, check out this NSHipster post: Swift Documentation

1 Like
3

Thanks for your explanation!