mirror of
https://github.com/github/codeql.git
synced 2026-02-19 08:23:45 +01:00
e21cbe82a9
Where possible update Java documentation links to Java 11. Additionally update some other links to use HTTPS.
51 lines
1.7 KiB
XML
51 lines
1.7 KiB
XML
<!DOCTYPE qhelp PUBLIC
|
|
"-//Semmle//qhelp//EN"
|
|
"qhelp.dtd">
|
|
<qhelp>
|
|
<overview>
|
|
<p>
|
|
This metric measures the number of interfaces below this location in the tree.
|
|
At a file level, this would just be the number of interfaces in the file.
|
|
</p>
|
|
|
|
<p>
|
|
In general, it is not a good idea to put multiple interfaces in the same file.
|
|
Interfaces are intended in some sense to be publicly visible, and changes to
|
|
them are expected to have a higher impact than changes to internal classes.
|
|
Making a change to an interface forces everybody who depends on that interface
|
|
to recompile their code, which is already hugely disruptive. If multiple
|
|
interfaces are in the same file, not only do the people who depend on the
|
|
changing interface need to recompile, but so does everyone who depends on any
|
|
of the interfaces in the file (since they have a physical dependency on the
|
|
file, not just a logical dependency on one of the interfaces in it). For this
|
|
reason, a strict rule of one interface per file should be rigorously enforced.
|
|
</p>
|
|
|
|
<p>
|
|
Note that this should be compared to the advice for classes - whilst it is
|
|
advisable to use a single file for each class, it is acceptable to put classes
|
|
in the same file when they are logically related (if only then). It is far
|
|
less acceptable in the case of interfaces due to their public-facing nature.
|
|
</p>
|
|
|
|
</overview>
|
|
<recommendation>
|
|
|
|
<p>
|
|
Any interfaces that currently share a source file with another interface (or
|
|
indeed a class) should be given their own file.
|
|
</p>
|
|
|
|
|
|
</recommendation>
|
|
<references>
|
|
|
|
|
|
<li>
|
|
Java Language Specification. <a href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-9.html">9 Interfaces</a>.
|
|
</li>
|
|
|
|
|
|
</references>
|
|
</qhelp>
|