2 ms·
I propose we start the revolution with comment blocks. https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_markup_formatting_ref/Co
by CharlesW 3y ago
I propose we start the revolution with comment blocks.
https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_markup_formatting_ref/ComentBlock.html https://developer.apple.com/library/archive/documentation/Xc...
- metadat 3y agoWhat is the colon (:) thing about? E.g. /*: Some comment */ Is there a legitimate reason for the non-C addition atop a C-syntax? Edit: Thanks for explaining!
- thristian 3y agoIt seems to be a convention that means "this comment contains Markdown and should be rendered in the generated documentation" as opposed to commenting out unused code or whatever.
- nyolfen 3y agoit's to mark the comments in these blocks to be extracted for formatted documentation generation rather than conventional code comments
- Someone 3y agoWeirdly, it doesn’t seem to be DocC (https://developer.apple.com/documentation/docc https://developer.apple.com/documentation/docc)