hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-05 21:55:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update qhelp with content and remove autogenerated qhelp files

Browse Source
This commit is contained in:
Felicity Chapman
2018-11-08 16:16:50 +00:00
parent 73675e29f2
commit 8a444b6034
19 changed files with 61 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
cpp/ql/src/Metrics/Namespaces/AbstractNamespaces.qhelp
View File

@@ -9,21 +9,17 @@
<p>Abstractness measures the proportion of abstract types in
a package relative to the total number of types in that package.
A highly abstract package (where the metric value is close 1)
that is furthermore instable is likely to be useless: the
class hierarchy has been over-engineered, and all those
abstract types are not heavily used.</p>
A metric value close to 1 indicates a highly abstract package
that is also unstable. The class hierarchy is probably over-engineered, and the abstract types are unlikely to be much used.</p>
</overview>
<section title="How to Address the Query Results">
<p>Try to simplify the class hierarchy.</p>
<recommendation>
<p>Consider reducing the level of abstraction by simplifying the class hierarchy.</p>
</recommendation>
</section>
<references>
<li>C++ reference: <a href="https://en.cppreference.com/w/cpp/language/namespace">Namespaces</a>
</li>
<li>Geeks for Geeks: <a href="https://www.geeksforgeeks.org/abstraction-in-c/">Abstraction in C++</a></li>
</references>
</qhelp>