github / github/codeql

Java: Javadoc matches regular comments

未關閉
#3,695 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
Java question
主要語言
CodeQL
星號
10.1k
分支
2.1k
平均合併
2 天 15 小時
30 天內合併 PR
141

描述

**Description of the issue**
It appears `Javadoc` and some of the related classes match regular comments. This is pretty misleading because normally javadoc only refers to `/** ... */`, neither any of the QL classes nor the documentation of the containing module mentions this.
The [Learn QL: Javadoc](https://github.com/github/codeql/blob/master/docs/language/learn-ql/java/javadoc.rst) does not mention this either.

Similarly the concept of javadoc tags does not apply to regular comments (interestingly QL seems to honor that and does not find any in regular comments).

Example query:
```ql
from Javadoc javadoc
where
not exists (javadoc.getCommentedElement())
// Exclude license headers, though they are not javadoc either
and javadoc.getLocation().getStartLine() > 10
select javadoc
```

If you decide to stick to this decision, could the documentation of the QL classes and the module please be clarified and could respective predicates for comment types be added (though it might be hard to choose predicate names which are not misleading):
- is block comment (the JLS calls them ["traditional comment"](https://docs.oracle.com/javase/specs/jls/se14/html/jls-3.html#jls-3.7), though that is not very meaningful)
- is line comment

The currently existing predicate `getCommentedElement()` is not enough to determine whether it is a javadoc comment or a regular comment (since one could place `/** ... */` anywhere).
`semmlecode.dbscheme` provides `isNormalComment(@javadoc)`, but is that an implementation detail or may it be used?

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。