Skip to content

Instantly share code, notes, and snippets.

@norio-nomura
Last active February 26, 2017 00:18
Show Gist options
  • Save norio-nomura/a439b2fcf7197fe301fa to your computer and use it in GitHub Desktop.
Save norio-nomura/a439b2fcf7197fe301fa to your computer and use it in GitHub Desktop.
Xcode 7が認識するQuickHelpのキーワード
/// not start with - makes Description slice
/// - Parameter parameterName: is slice label
/// - Throws: is slice label
/// - Returns: is slice label
/// - Attention: is section label
/// - Author: is section label
/// - Authors: is section label
/// - Bug: is section label
/// - Complexity: is section label
/// - Copyright: is section label
/// - Date: is section label
/// - Experiment: is section label
/// - Important: is section label
/// - Invariant: is section label
/// - Note: is section label
/// - Postcondition: is section label
/// - Precondition: is section label
/// - Remark: is section label
/// - Requires: is section label
/// - Since: is section label
/// - TODO: is section label
/// - Version: is section label
/// - Warning: is section label
/**
Inside multiline comments, Parameters allows child elements.
- Parameters:
- parameterName1: is slice label
- parameterName2: is slice label
*/
@norio-nomura
Copy link
Author

複数行コメントだと - Parameters: も使える事を追記した。
https://twitter.com/cockscomb/status/638945406848622593

@dictav
Copy link

dictav commented Sep 5, 2015

複数行コメントの末尾は */ かと思います。

@norio-nomura
Copy link
Author

ありがとうございます。複数行コメントの末尾を */ に修正しました。

@norio-nomura
Copy link
Author

- SeeAlso: は認識されなくなったぽい

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment