assertj / assertj/assertj-generator
Add @see tags to methods to point back to the original member
- Lingua principale
- Java
- Stelle
- 72
- Fork
- 47
- Merge medio
- 1g 16h
- PR unite (30g)
- 2
Descrizione
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;
}
```
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
L’issue non indica file, test o punti di ingresso. Inizia individuando il codice del generatore che emette gli Javadocs per i metodi di asserzione generati e gli eventuali test che coprono quell’output; il lavoro è completato quando i metodi generati includono un link @see come Foo#getBar() con l’etichetta "Member under test".
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 38/100