assertj / assertj/assertj-generator
Add @see tags to methods to point back to the original member
- Lenguaje dominante
- Java
- Estrellas
- 72
- Forks
- 47
- Merge medio
- 1 d 16 h
- PR fusionados (30 d)
- 2
Descripción
It'd be helpful if generated methods included an `@see` to the member the value was generated from.
## Example
### Given
```java
class Foo {
public int getBar() {
return 0;
}
}
```
### Actual
```java
/**
* 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
```java
/**
* 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;
}
```
Guía de contribución
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.
Evaluación
- Stack tecnológico
- java
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100