Local Doc Comment

Prefer regular comments over doc comments in local scopes

  • Identifier: local_doc_comment
  • Enabled by default: No
  • Supports autocorrection: No
  • Kind: lint
  • Analyzer rule: No
  • Minimum Swift compiler version: 5.0.0
  • Default configuration:
    KeyValue
    severity warning

Non Triggering Examples

func foo() {
  // Local scope documentation should use normal comments.
  print("foo")
}

/// My great property
var myGreatProperty: String!

/// Look here for more info: https://github.com.
var myGreatProperty: String!

/// Look here for more info:
/// https://github.com.
var myGreatProperty: String!

Triggering Examples

func foo() {
  ↓/// Docstring inside a function declaration
  print("foo")
}