rspec/rules/S1451/vbnet/rule.adoc

43 lines
1.2 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
Each source file should start with a header stating file ownership and the license which must be used to distribute the application.
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
This rule must be fed with the header text that is expected at the beginning of every file.
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
The ``++headerFormat++`` must end with an empty line if you want to have an empty line between the file header and the first line for your source file (``++using++``, ``++namespace++``...).
2020-06-30 12:47:33 +02:00
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
For example, if you want the source file to look like this
2020-06-30 12:47:33 +02:00
----
' Copyright (c) SonarSource. All Rights Reserved. Licensed under the LGPL License. See License.txt in the project root for license information.
namespace Foo
{
}
----
2021-01-27 13:42:22 +01:00
then the ``++headerFormat++`` parameter should end with an empty line like this
----
' Copyright (c) SonarSource. All Rights Reserved. Licensed under the LGPL License. See License.txt in the project root for license information.
----
2020-06-30 12:47:33 +02:00
include::../compliant.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]