If you would like to communicate a certain piece of code which you feel needs a refactor, back to fellow maintainers, you MUST add a comment prefixed with "REFACTOR REQUIRED"

[BenjaminRCooper]

If you have a spike within your project, using this approach will allow maintainers to quickly scan a file and understand what parts could do with a new approach.

Using this approach, you COULD also contain a description of why you feel a certain method requires a refactor and also recommend new approaches.

Example

/*
 * REFACTOR REQUIRED
 *
 * A description of why you think it should be refactored e.g. bad performance
 *
 * Recommended solution if you have one
 */

[iamrossgrant]

+1

[jonspark]

What about including an @todo? It should show up in the IDE or at least a search.

[BenjaminRCooper]

That was my first thought, using the following two approaches, as I have seen them used before;

• @todo
• @fixme

Using one if something isn't finished, and one for when something needs refactoring.

Thoughts?

Ben

[lewismorris]

+1 for using @todo

[jonspark]

Go for both... each has it's own meaning. Even if you use the proposed format, just adding @todo or @fixme will create a useful marker.

[ampersarnie]

+1 for both

[BenjaminRCooper]

Agreed.

Will change the standard when I have a little time.

Ben

[timgale]

+1

[BenjaminRCooper]

Implemented