Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Expand file tree

/

UncommentedFunction.ql

Copy path
More file actions
More file actions

Latest commit

 

History

History
History
23 lines (21 loc) · 709 Bytes
/

UncommentedFunction.ql

Copy path

File metadata and controls

23 lines (21 loc) · 709 Bytes
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/**
* @name Poorly documented large function
* @description Large functions that have no or almost no comments are likely to be too complex to understand and maintain. The larger a function is, the more problematic the lack of comments.
* @kind problem
* @problem.severity warning
* @precision medium
* @id cpp/poorly-documented-function
* @tags maintainability
* documentation
* statistical
* non-attributable
*/
import cpp
from MetricFunction f, int n
where
n = f.getNumberOfLines() and
n > 100 and
f.getCommentRatio() <= 0.02 and
not f.isMultiplyDefined()
select f,
"Poorly documented function: fewer than 2% comments for a function of " + n.toString() + " lines."
Morty Proxy This is a proxified and sanitized view of the page, visit original site.