Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

incorrect detection of missing comment

Abierto
  • ¿Algo no está bien?
#138 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
java
Área
tooling

Línea de trabajo

Reproduce la infracción CommentRequired usando PMD plugin 4.18.0.v20201024-1129 y PMD 6.29.0 contra org.eclipse.titan.runtime/src/org/eclipse/titan/runtime/core/TitanLoggerApi.java, centrándote en la línea 1382. Compara el método indicado con el siguiente método público e inspecciona si el tamaño del archivo generado afecta a la detección de comentarios. El trabajo está terminado cuando el false positive se haya explicado y corregido o se haya reproducido de forma fiable con una prueba de regresión.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

When running the latest PMD plugin on our code we get a violation report we believe to be false positive.
PMD plugin version used is: 4.18.0.v20201024-1129
Containing PMD version: 6.29.0

The project used is open source: https://github.com/eclipse/titan.EclipsePlug-ins
The file where we get the report is: https://github.com/eclipse/titan.EclipsePlug-ins/blob/master/org.eclipse.titan.runtime/src/org/eclipse/titan/runtime/core/TitanLoggerApi.java
in line : 1382
violation report: "CommentRequired: Public method and constructor comments are required"

The code in question looks like this:
"
/**
* Gives access to the field id.
* Turning the template into a specific value template if needed.
*
* @return the field id.
* */
public TitanInteger_template get_field_id() {
set_specific();
return id;
}
"
As it can be seen while the function is truly public ... it also visibly has a comment.
What makes this issue more interesting is that this does not look like a consistent problem.
The public function directly following this one (with very similar signature and comment shape/form/content) does not have this violation reported on it.
I have attached 2 images showing both functions together and the reported violation.
kép
kép

Please note this happens several times in the code ... this occurrence was just the smallest I could find to demonstrate the issue.

Please also note, that this file is generated and so quite large (>160K lines).
This might play a role in creating the issue.

Lenguaje dominante
Java
Estrellas
99
Forks
42
Merge medio
1 d 2 h
PR fusionados (30 d)
10

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de pmd/pmd-eclipse-plugin

Todos los issues de pmd/pmd-eclipse-plugin

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.