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.
62 lines
1.2 KiB
Plaintext
62 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Sharing some naming conventions is a key point to make it possible for a team to efficiently collaborate.
|
|
|
|
This rule allows to check that all interface names match a provided regular expression.
|
|
|
|
|
|
The default configuration is the one recommended by Microsoft:
|
|
|
|
|
|
* Must start with an upper case 'I' character, e.g. IFoo
|
|
* Followed by Pascal casing, starting with an upper case character, e.g. IEnumerable
|
|
* Short abbreviations of 2 letters can be capitalized, e.g. IFooID
|
|
* Longer abbreviations need to be lower cased, e.g. IFooHtml
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default regular expression ``++^I([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$++``:
|
|
|
|
[source,vbnet]
|
|
----
|
|
Interface Foo ' Noncompliant
|
|
End Interface
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Interface IFoo ' Compliant
|
|
End Interface
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
_STRING_
|
|
|
|
----
|
|
^I([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$
|
|
----
|
|
|
|
Regular expression used to check the interface names against.
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
endif::env-github,rspecator-view[]
|