I am really struggling to understand what you mean with this. I mean, did it break because of the placement of the comments? Or did you remove the comments because the formatter didn’t want you to put them there?
Either way though, I’m one of those that think a codebase full of comments normally is a code smell. And well, I say normally because I know there are places we totally need to leave comments, and depending on the complexity of application you’re writing, this might happen more often.
Anyway, I really try to write the code in a clear way that makes it obvious to other people what it should be doing, so no comment is needed. When that’s not possible, then I extract functions for the parts that need more explanation and write comments as if they were an @doc, which doesn’t get rearranged by the formatter.
So in the end, again, you just kinda adapt your code, to find a way that the formatter accepts and it’s pleasing for you. It might not be perfect for you, but when there are multiple people, you have to play the good citizen because maybe what’s perfect for you might not be perfect for them, so you have to both meet in the middle, and the formatter is a good way to do that IMO.
