assertj / assertj/assertj-generator

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

オープン
#100 コメント 3 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
Java
スター
72
フォーク
47
平均マージ
1日 16時間
マージ済み PR(30日)
2

説明

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;
}
```

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

この issue ではファイル、テスト、エントリーポイントが指定されていません。まず、生成された assertion メソッドの Javadocs を出力する generator code と、その出力を対象とするテストを探します。生成されたメソッドに、ラベル "Member under test" 付きの Foo#getBar() のような @see リンクが含まれていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
tooling
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。