16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
74 lines
1.3 KiB
Plaintext
74 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,swift]
|
|
----
|
|
var name = "Bob" // Noncompliant
|
|
|
|
func doSomething() { // Noncompliant
|
|
//...
|
|
}
|
|
|
|
class MyClass {
|
|
//...
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,swift]
|
|
----
|
|
public class MyClass {
|
|
public static var name = "Bob"
|
|
|
|
public class func doSomething() { // Compliant
|
|
//...
|
|
}
|
|
//...
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
The operator function is a function with a name that matches the operator to be overloaded. Because such functions can only be defined in a global scope, they are ignored by this rule.
|
|
|
|
[source,swift]
|
|
----
|
|
public class Vector2D {
|
|
var x = 0.0, y = 0.0
|
|
// ...
|
|
}
|
|
|
|
func + (left: Vector2D, right: Vector2D) -> Vector2D {
|
|
return Vector2D(x: left.x + right.x, y: left.y + right.y)
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Move this [function|variable|constant] into a class.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== on 13 May 2015, 09:10:30 Elena Vilchik wrote:
|
|
\[~ann.campbell.2] Could you verify exception description?
|
|
|
|
=== on 13 May 2015, 13:32:13 Ann Campbell wrote:
|
|
I made a couple tiny edits [~elena.vilchik], but this looks good
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|