Add @see tags to methods to point back to the original member

Abierto
#100 3 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
38/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
java
Área
tooling

Línea de trabajo

El issue no menciona archivos, pruebas ni puntos de entrada. Empieza localizando el código del generador que emite Javadocs para los métodos de aserción generados y cualquier prueba que cubra esa salida; se considera terminado cuando los métodos generados incluyen un enlace @see como Foo#getBar() con la etiqueta "Member under test".

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

Descripción

It'd be helpful if generated methods included an @see to the member the value was generated from.

Example

Given
class Foo {
  public int getBar() {
    return 0;
  }
}
Actual
  /**
   * Verifies that the actual Foo's bar is equal to the given one.
   * @param bar the given bar to compare the actual Foo's bar to.
   * @return this assertion object.
   * @throws AssertionError - if the actual Foo's bar is not equal to the given one.
   */
  public FooAssert hasBar(int bar) {
    // ... cut for brevity ...
    return this;
  }
Expected
  /**
   * Verifies that the actual Foo's bar is equal to the given one.
   * @param bar the given bar to compare the actual Foo's bar to.
   * @return this assertion object.
   * @throws AssertionError - if the actual Foo's bar is not equal to the given one.
   * @see Foo#getBar() Member under test.
   */
  public FooAssert hasBar(int bar) {
    // ... cut for brevity ...
    return this;
  }
Lenguaje dominante
Java
Estrellas
72
Forks
47
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

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 assertj/assertj-generator

Todos los issues de assertj/assertj-generator

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.