AutoRefactor icon indicating copy to clipboard operation
AutoRefactor copied to clipboard

Do not refactor comment to Javadoc if the comment is a FIXME or a TODO

Open garsEstTemps opened this issue 10 years ago • 2 comments

Given

The following code:

    // FIXME: When pigs fly
    public void goofingAround(final String test) {
        return;
    }

When

... automatic refactoring are applied...

Then

Actual result Comment is refactored to javadoc

    /** FIXME: When pigs fly */
    public void goofingAround(final String test) {
        return;
    }

Expected result

Code should not be refactored.

garsEstTemps avatar Apr 10 '15 13:04 garsEstTemps

What is the rationale for not refactoring it? I can't really think why you would not want this to happen?

JnRouvignac avatar Apr 15 '15 10:04 JnRouvignac

I just felt a bit strange to have a FIXME or TODO in javadoc to be honest... it is more an improvment suggestion than a bug.

garsEstTemps avatar Apr 15 '15 14:04 garsEstTemps