Comment formatting not idempotent

[jhaber]

We're seeing code that needs to be formatted 3 times before it stabilizes and the final formatting doesn't look right.

(All of these are formatted with print-width=70)

Input:

public class Example {
  Map<String, String> map =
    // there is a random comment on this line up here
    // and then there is a separate comment on this line down here
    new HashMap<>(
      someRandomMethodThatReturnsTheInitialMapThatWeWantToMutate()
    );
}

Output after first formatting:

public class Example {
  Map<String, String> map = // there is a random comment on this line up here
  // and then there is a separate comment on this line down here
  new HashMap<>(
    someRandomMethodThatReturnsTheInitialMapThatWeWantToMutate()
  );
}

Output after second formatting:

public class Example {
  Map<String, String> map = // and then there is a separate comment on this line down here // there is a random comment on this line up here
  new HashMap<>(
    someRandomMethodThatReturnsTheInitialMapThatWeWantToMutate()
  );
}

Output after third formatting (stable after this):

public class Example {
  Map<String, String> map = new HashMap<>( // and then there is a separate comment on this line down here // there is a random comment on this line up here
    someRandomMethodThatReturnsTheInitialMapThatWeWantToMutate()
  );
}

I believe the issue is related to the placement of the comments, moving them elsewhere solves the issue

[clementdessoude]

Ah yes, we are still facing some issues with comments when there are placed at some unexpected places. For instance:

class T {

  public void t() {
    for
    // one
    // two
    (;;) {
      int i = 1;
      int j = 2;
    }
  }
}

is not idempotent either.

[clementdessoude]

In your case, I am pretty sure that putting the comments before the Map<String, String> map = should be ok